Skip to content

Update docs to include operations #422

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 15 commits into from
Oct 15, 2024
Merged

Update docs to include operations #422

merged 15 commits into from
Oct 15, 2024

Conversation

sjpb
Copy link
Collaborator

@sjpb sjpb commented Aug 13, 2024 •
edited
Loading

  • Added docs/operations.md
  • Added docs/site.md as placeholder for site-specific documentation
  • Refactored main README to only cover deploying a "default" cookiecutter-created environment

@sjpb sjpb changed the title Update README.md to improve new deployment instructions Update docs to include operations Oct 8, 2024
@sjpb sjpb marked this pull request as ready for review October 8, 2024 15:37
@sjpb sjpb requested a review from a team as a code owner October 8, 2024 15:37
@sjpb sjpb requested a review from bertiethorpe October 8, 2024 15:37
bertiethorpe
bertiethorpe reviewed Oct 8, 2024
View reviewed changes
@bertiethorpe
Copy link
Member

Should we wait for #440 to merge before adjusting the CI docs to reflect these changes?

sd109
sd109 requested changes Oct 9, 2024
View reviewed changes
Copy link
Member

@sd109 sd109 left a comment

Choose a reason for hiding this comment

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

Looks like a great start, just a few minor nit picks that I've spotted so far.

@sjpb sjpb requested a review from bertiethorpe October 9, 2024 12:23
@sjpb sjpb requested a review from sd109 October 10, 2024 13:54
@sjpb
Copy link
Collaborator Author

sjpb commented Oct 11, 2024

Should we wait for #440 to merge before adjusting the CI docs to reflect these changes?

Actually that PR is all for our own CI, really we're trying to focus on docs for "downstream" users here.

sd109
sd109 requested changes Oct 14, 2024
View reviewed changes
Copy link
Member

@sd109 sd109 left a comment

Choose a reason for hiding this comment

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

This is looking great, just a few more minor questions and fixes.

@sjpb sjpb requested a review from sd109 October 15, 2024 09:37
sd109
sd109 approved these changes Oct 15, 2024
View reviewed changes
Copy link
Member

@sd109 sd109 left a comment

Choose a reason for hiding this comment

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

LGTM

@sjpb sjpb merged commit c7f3b24 into main Oct 15, 2024
@sjpb sjpb deleted the docs/setup branch October 15, 2024 13:15
MaxBed4d pushed a commit that referenced this pull request Oct 15, 2024
@sjpb @bertiethorpe
@sd109 @MaxBed4d
Update docs to include operations (#422)
52367cc 
* Update README.md

* OSes supported as deploy hosts

* undo readme OSes supported

* add operations docs

* simplify main README.md to only cover default configuration

* move more-specific documentation into their own files

* provide site docs directory

* address docs review comments

* Fix a / in docs

Co-authored-by: Scott Davidson <[email protected]>

* address PR comments on docs

* address PR comments on docs

---------

Co-authored-by: bertiethorpe <[email protected]>
Co-authored-by: Scott Davidson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sd109 sd109 sd109 approved these changes

@bertiethorpe bertiethorpe Awaiting requested review from bertiethorpe

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sjpb @bertiethorpe @sd109