Doc improvements #125

New Issue

dboreham · 2023-01-17T18:17:33Z

dboreham commented

2023-01-17 18:17:33 +00:00

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.
#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

Sign in to join this conversation.

No Milestone

No project

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: cerc-io/stack-orchestrator#125