Skip to content

process: define documentation_management.rst - #436

Merged
aschemmel-tech merged 2 commits into
mainfrom
aschemmel-tech-patch-1
Feb 28, 2025
Merged

aschemmel-tech merged 2 commits into
mainfrom
aschemmel-tech-patch-1

Conversation

@aschemmel-tech

@aschemmel-tech aschemmel-tech commented Feb 21, 2025 •

Copy link
Copy Markdown
Contributor

Ref: closes #317

@github-actions

Copy link
Copy Markdown
Contributor

The created documentation from the pull request is available at: docu-html

@aschemmel-tech
aschemmel-tech force-pushed the aschemmel-tech-patch-1 branch 2 times, most recently from 83ba258 to 0387c20 Compare February 21, 2025 11:09
@aschemmel-tech
aschemmel-tech marked this pull request as ready for review February 21, 2025 11:12
@aschemmel-tech
aschemmel-tech marked this pull request as draft February 21, 2025 12:03
@aschemmel-tech

Copy link
Copy Markdown
Contributor Author

forgot the process requirements

Comment thread docs/platform_management_plan/documentation_management.rst Outdated
Comment thread docs/platform_management_plan/documentation_management.rst
Comment thread docs/platform_management_plan/documentation_management.rst
Comment thread docs/platform_management_plan/documentation_management.rst Outdated
@aschemmel-tech
aschemmel-tech force-pushed the aschemmel-tech-patch-1 branch 2 times, most recently from 7502951 to bd971b8 Compare February 21, 2025 13:51
@aschemmel-tech
aschemmel-tech marked this pull request as ready for review February 21, 2025 13:51
Comment thread docs/platform_management_plan/documentation_management.rst Outdated
Comment thread docs/process/process_areas/documentation_management/guidance/process_req.rst Outdated
Comment thread docs/process/process_areas/documentation_management/index.rst
Comment thread docs/platform_management_plan/project_management.rst Outdated
Comment thread docs/process/process_areas/documentation_management/guidance/process_req.rst Outdated
Comment thread docs/process/process_areas/documentation_management/guidance/process_req.rst Outdated
Comment thread docs/process/process_areas/documentation_management/guidance/process_req.rst Outdated
Comment thread docs/process/process_areas/documentation_management/guidance/process_req.rst Outdated
Comment thread docs/process/process_areas/documentation_management/guidance/process_req.rst Outdated
Comment thread docs/process/process_areas/documentation_management/guidance/process_req.rst Outdated
Comment thread docs/process/workproducts/index.rst
Comment thread docs/platform_management_plan/documentation_management.rst Outdated
Comment thread docs/platform_management_plan/documentation_management.rst
Work Products
^^^^^^^^^^^^^

:need:`doc__documentation_mgt_plan` is a document and part of the work product :need:`wp__platform_mgmt`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is a reference from the process_areas to the actual implementation in the docs/platform_management_plan the right way to link? Shouldn't this point to a template or something? Otherwise the process direct to its implementation and it is hard to treat this as the meta model consistent in its own.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not think our primary goal is to define a process model for every project to be usable, but for the S-CORE project. Thus I would not spend the effort to create a template for something we only need once in the project but directly instantiate it (this is true for all the "PMP" documents). We may do this in future releases.

Comment thread docs/process/workproducts/index.rst Outdated

@hoe-jo hoe-jo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@aschemmel-tech
aschemmel-tech merged commit a95d923 into main Feb 28, 2025
@aschemmel-tech
aschemmel-tech deleted the aschemmel-tech-patch-1 branch February 28, 2025 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improvement: Document "Documentation Management Process"

5 participants