Skip to end of metadata
Go to start of metadata

Component Docs

All,
Just a reminder that component documentation should be finished by 19 Oct 2018.
For component documentation patches:

  • Please use Jira ticket 1293 (https://jira.acumos.org/browse/ACUMOS-1293) for patches to component documentation
    • Prior to creating the "athena" release branch, doc updates should be in the master branch of your repository
    • After creating the athena release branch, any last-minute doc updates should be in the athena branch of your repository
  • Please assign the component's project PTL as a reviewer
  • Please assign Aimee Ukasick and/or Lorraine Welch as reviewers

PTLs: Please help the Docs team review docs patches for the components in your project. The Docs team can check RST syntax but we are *not* able to verify that the content is accurate and in-depth. Your help in reviewing your project's documentation patches is very much appreciated!

Documentation resources:

Please reach out to the Docs team if you have questions.


End User Docs

All,
Just a reminder that end user documentation should be finished by 19 Oct 2018. The Docs team (Aimee) needs your help to ensure the end-user-facing docs are current. I will be reviewing all the end-user docs for accuracy and updating screen shots.  I used the docs-impact tag on Jira tickets that required a documentation update, but I may have missed some.
If you implemented new functionality that impacts an end user, please help me out and submit a patch!

Teams responsible for content of docs kept in documentation repo:

  • System Integration team:
    • documentation/docs/AcumosUser/onclick-deploy
  • Portal Marketplace team:
    • documentation/docs/AcumosUser/portal-admin
    • documentation/docs/AcumosUser/portal-user/marketplace
  • Design Studio team:
    • documentation/docs/AcumosUser/portal-user/design-studio
  • Deployment team:
    • documentation/docs/AcumosUser/portal-user/deployment
  • On-Boarding team:
    • documentation/docs/AcumosUser/portal-user/portal
    • Note: updates to instructions for using the Python client library are made in the acumos-python-client project because those docs are displayed on PyPI.


For documentation patches:

  • Please use Jira ticket 1294 (https://jira.acumos.org/browse/ACUMOS-1294) for patches to the end user documentation (or create a sub-task)
    • Prior to creating the "athena" release branch, doc updates should be in the master documentation branch
    • After creating the athena release branch, any doc updates should be in the athena documentation branch
  • Please assign Aimee Ukasick and/or Lorraine Welch and/or Bryan Sullivan as reviewers



Documentation resources:

Please reach out to the Docs team if you have questions.

Thanks for your help!


  • No labels