SLIM integration: Infusion of Lab-approved documentation and templating standards
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- content, documentation
Research direction
Begin by reviewing the slim_infusion branch and its commit history, then compare the added documentation and template files with this repository. Confirm which files are tailored for anms-docs and identify the integration points requiring CogE or developer upkeep. Done means the Lab-approved documentation and templates are added with the requested minimal integration.
Written by the indexing model from the issue text.
Description
Checked for duplicates
Yes -- New feature, new files.
Alternatives considered
Yes - This is a Lab-approved and suggested addition to all NASA-AMMOS repositories.
Related problems
Many repos don't provide comprehensive documentation and/or are missing key areas of standardized documentation focus. This feature adds standardized documentation per Lab-approved standards.
Describe the feature request
A number of template and documentation files are being added to the repository in support of the SLIM project. These files are suggested by MGSS and will serve to promote cohesion between NASA-AMMOS products. The files provided are tailored to the current repository with minimal integration assistance and upkeep requested of the CogE and/or developers.
See commit history in the slim_infusion branch for added files.
- Dominant language
- CMake
- Stars
- 2
- Forks
- 1
- Avg merge
- 6d 23h
- Merged PRs (30d)
- 2
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from NASA-AMMOS/anms-docs
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
NASA-AMMOS/anms-docs#11 ·
-
Add product guide section before "Building" about prerequisitesMay be free again @BrianSipos claimed this 863 days ago, and no pull request is open. Open
NASA-AMMOS/anms-docs#6 · 1 comment · 1 assignee ·
All issues in NASA-AMMOS/anms-docs
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
ajeetraina/awesome-docker-sbx#286 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
OpenRA/OpenRAWebsiteV3#102 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
remoteintech/remote-jobs#2271 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 60/100
521xueweihan/HelloGitHub#3924 ·
-
approved check:passed streams:add
Difficulty 1/5 Under an hour Newbie friendliness 75/100
Maintainers usually reply within 1 day