Documentation
Space shortcuts
Page tree

Versions Compared

Old Version 64

changes.mady.by.user Aimee Ukasick

Saved on

compared with

New Version 65

changes.mady.by.user Aimee Ukasick

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Welcome to the Acumos Documentation project page!

If you are looking for Acumos platform documentation, please visit docs.acumos.org.

Project Description:

  • The Docs team is responsible for the documentation curation, procedures, best practices and tools
  • The documentation repository contains end-user guides, with content provided by the developers who work on the Portal Marketplace, Design Studio, Onboarding, Deployment, Platform OA&M, and System Integration components
  • Editorial support in producing project-and-component-level documentation for Acumos releases
  • Define guidelines and tooling for documentation handling across all Acumos projects
    • Style Guide
    • Templates
    • Tooling for locally building docs with Sprinx
  • Maintain the Acumos documentation project 

The Art of Documentation for Open Source Projects - Ben Hall, Katacoda


Info
titleKey Project Facts


PTLAimee Ukasick (aimeeu)None - contact the TSC if you are interested
Mailing List

acumosaidevdiscuss - use tag "[docs]" in the subject line

@TODO - add link to mailing list archive

IRC Channel#acumos-docs
Repo

Gitweb

Github clone

Gerrit

for patches:

git clone ssh://<yourGerridID>@gerrit.acumos.org:29418/documentation

anonymous:

git clone https://gerrit.acumos.org/r/documentation

Jirahttps://jira.acumos.org component is "documention"
CommittersAimee Ukasick (aimeeu)
  • Bryan Sullivan (blsaws)
  • Lorraine Welch

Please note that Docs project team members are all part-time or less, so it may take time to respond to inquiries.

Meetings

No scheduled meetings. Feel free to reach out via email or IRC.

Etherpad: https://etherpad.acumos.org/p/docs-project

IRC: #acumos-docs

Zoom Meeting URL: https://zoom.us/j/9266141474

Contributor's GuideDocs Contributor Guide – this is a WIP - help us improve it!


View Git file
pathINFO.yaml
repository-id14
branchrefs/remotes/origin/master

@TODO - add links to planning etherpads, formal release plans, and areas that need major work


Team Calendars
defaultViewmonth
id04efa532-3bc9-4009-ba2d-b51c5ec3598a
hideWeekendstrue


Boreas Initiatives

  • Technical
    • Acumos-1178 Add "Report Issue" ribbon
    • Acumos-1177 Convert Docs project and component projects to use Intersphinx linking

All Open Docs Items

Jira
serverAcumos
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution,labels
maximumIssues20
jqlQuerystatus in (Open, "In Progress", Reopened, Submitted) AND component = documentation
serverIdb0c898d0-efbc-3280-a961-8e922866a2a2

Recent space activity

Recently Updated
typespage, comment, blogpost
max5
hideHeadingtrue
themesocial

Space contributors

Contributors
modelist
scopedescendants
limit5
showLastTimetrue
orderupdate