cerc-io/stack-orchestrator
Archived
12
1
Fork 3
Code Issues 117 Pull Requests 25 Actions Packages Projects Releases 493 Wiki Activity

Doc improvements #125

New Issue
Closed
opened 2023-01-17 18:17:33 +00:00 by dboreham · 0 comments
dboreham commented 2023-01-17 18:17:33 +00:00
Contributor
Copy Link
Copy Source

A place to collect small suggested improvements to the docs:

  • The section on installing prerequisites probably needs to be fleshed out -- the original intended audience was people who already understand the fine details of installing Python and Docker on whatever OS they are using. Likely it needs to be re-cast for a less knowledgeable audience. For example we should mention the versions of Python and Docker that we require.
  • Explain how S-O uses Docker and implement a sanity check that checks the min required Docker version is installed (#146)
  • The file tree here needs to be updated.
  • A link to the contributing/dev setup page should be added to the main readme.
  • Update the shiv build instructions to reference the new build script.
  • Add some doc on build versioning.
A place to collect small suggested improvements to the docs: - [x] The section on installing prerequisites probably needs to be fleshed out -- the original intended audience was people who already understand the fine details of installing Python and Docker on whatever OS they are using. Likely it needs to be re-cast for a less knowledgeable audience. For example we should mention the versions of Python and Docker that we require. - [x] #146 - [x] The file tree [here ](https://github.com/cerc-io/stack-orchestrator/blob/main/docs/spec.md)needs to be updated. - [x] A link to the contributing/dev setup page should be added to the main readme. - [x] Update the shiv build instructions to reference the new build script. - [ ] Add some doc on build versioning.
👍 1
This repo is archived. You cannot comment on issues.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
K8s
bug
Something isn't working
 documentation
Improvements or additions to documentation
 duplicate
This issue or pull request already exists
 enhancement
New feature or request
 feature
good first issue
Good for newcomers
 help wanted
Extra attention is needed
 in progress
invalid
This doesn't seem right
 question
Further information is requested
 wontfix
This will not be worked on
Copied from Github
An issue or PR manually copied from GitHub.
 Kind/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status
Need More Info
Feedback is required to reproduce issue or to continue work
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
AFDudley (A. F. Dudley) Alex ashwin cerccicd ericlewis i-norden (Ian Norden) prathamesh (Prathamesh Musale) rachmaninovquar rjk-laconic roysc (Roy Crihfield) srw (srw) zramsay
No Assignees
1 Participants
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: cerc-io/stack-orchestrator#125