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
Key Project Facts
| PTL | Akashdeep Srivastava |
| Mailing List | acumosaidevdiscuss - use tag "[docs]" in the subject line @TODO - add link to mailing list archive |
| IRC Channel | #acumos-docs |
| Repo | |
| Gerrit | for patches: git clone ssh://<yourGerridID>@gerrit.acumos.org:29418/documentation anonymous: git clone https://gerrit.acumos.org/r/documentation |
| Jira | https://jira.acumos.org component is "documention" |
| Committers |
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. Etherpad: https://etherpad.acumos.org/p/docs-project IRC: #acumos-docs |
| Contributor's Guide | Docs Contributor Guide – this is a WIP - help us improve it! |
---
project: 'documentation'
project_creation_date: '2017-11-17'
project_category: ''
lifecycle_state: 'Incubation'
project_lead: &acumos_documentation_ptl
name: 'Akashdeep Srivastava'
email: 'AS00493574@techmahindra.com'
company: 'Tech Mahindra'
id: 'Echelon'
timezone: 'India/Pune'
primary_contact: *acumos_documentation_ptl
issue_tracking:
type: 'jira'
url: 'https://jira.acumos.org/projects/ACUMOS'
key: 'ACUMOS'
mailing_list:
type: 'groups.io'
url: 'https://lists.acumos.org'
tag: '<[sub-project_name]>'
realtime_discussion:
type: 'irc'
server: 'freenode.net'
channel: '#acumos-docs'
meetings:
- type: 'zoom'
agenda: ''
url: 'https://zoom.us/j/9266141474'
server: 'n/a'
channel: '#acumos-docs'
repeats: 'weekly'
time: '14:00 ET'
repositories:
- 'documentation'
committers:
- <<: *acumos_documentation_ptl
- name: 'Lorraine Welch'
email: 'lb2391@att.com'
company: 'ATT'
id: 'lorraineawelch'
timezone: 'America/New_York'
tsc:
approval: 'https://lists.acumos.org/g/tscgeneral'
@TODO - add links to planning etherpads, formal release plans, and areas that need major work
- EDIT THE CALENDAR
Customise the different types of events you'd like to manage in this calendar.
#legIndex/#totalLegs - RESTRICT THE CALENDAR
Optionally, restrict who can view or add events to the team calendar.
#legIndex/#totalLegs - SHARE WITH YOUR TEAM
Grab the calendar's URL and email it to your team, or paste it on a page to embed the calendar.
#legIndex/#totalLegs - ADD AN EVENT
The calendar is ready to go! Click any day on the calendar to add an event or use the Add event button.
#legIndex/#totalLegs - SUBSCRIBE
Subscribe to calendars using your favourite calendar client.
#legIndex/#totalLegs
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
Recent space activity
