Skip to content
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

Tbeck/peng 1756 update wording throughout #383

Merged
merged 9 commits into from
Oct 19, 2023
Merged

Tbeck/peng 1756 update wording throughout #383

merged 9 commits into from
Oct 19, 2023

Conversation

dusktreader
Copy link
Member

A large overhaul of the documentation:

  • Converted to markdown
  • Used mkdocs-material as new renderer
  • Updated wording throughout
  • Added a github action to publish to github pages.

Peer Review

Please follow the upstream omnivector documentation concerning
peer-review guidelines.

fschuch
fschuch requested changes Oct 16, 2023
View reviewed changes
Copy link
Member

@fschuch fschuch left a comment

Choose a reason for hiding this comment

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

Great work. I left some comments.

.github/workflows/build_docs.yaml Show resolved Hide resolved
jobbergate-docs/CHANGELOG.md Show resolved Hide resolved
jobbergate-docs/docs/source/contact.md Outdated Show resolved Hide resolved
jobbergate-docs/docs/source/developer_guide/ci.md Show resolved Hide resolved
jobbergate-docs/docs/source/developer_guide/ci.md Outdated Show resolved Hide resolved
jobbergate-docs/docs/source/developer_guide/dev_tools.md Show resolved Hide resolved
jobbergate-docs/docs/source/developer_guide/integration_testing.md Outdated Show resolved Hide resolved
jobbergate-docs/docs/source/developer_guide/integration_testing.md Show resolved Hide resolved
.github/workflows/build_docs.yaml Outdated Show resolved Hide resolved
jobbergate-docs/src/developer_guide/s3_file_storage.rst Show resolved Hide resolved
@dusktreader dusktreader force-pushed the tbeck/PENG-1756--update-wording-throughout branch from 1a5dcaa to d68a6dc Compare October 17, 2023 16:46
fschuch
fschuch reviewed Oct 17, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@dusktreader dusktreader force-pushed the tbeck/PENG-1756--update-wording-throughout branch from 2424f77 to 42dfe1d Compare October 19, 2023 18:29
@dusktreader dusktreader merged commit d3f8c7c into main Oct 19, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fschuch fschuch fschuch approved these changes

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

Successfully merging this pull request may close these issues.
2 participants
@dusktreader @fschuch