Skip to content

Reorganize docs folder #1150

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 5 commits into from
Aug 9, 2023
Merged

Reorganize docs folder #1150

merged 5 commits into from
Aug 9, 2023

Conversation

jpraynaud
Copy link
Member

@jpraynaud jpraynaud commented Aug 9, 2023 •
edited
Loading

Content

This PR includes some reorganization of the docs folder:

  • docs/website: the already existing documentation website which was in docs
  • docs/runbook: the new runbook documentation will be created in this folder
  • Documentation workflow has been updated accordingly
  • Doc website dependencies have been upgraded
  • Current version of the doc website has been created from next version

Pre-submit checklist

  • Branch
    • Crates versions are updated (if relevant)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update documentation website (if relevant)

Issue(s)

Relates to #1085

@jpraynaud jpraynaud self-assigned this Aug 9, 2023
@jpraynaud jpraynaud requested a review from Alenar August 9, 2023 08:36
@github-actions
Copy link

github-actions bot commented Aug 9, 2023

Test Results

    3 files  ±0    16 suites  ±0   5m 33s ⏱️ -56s
656 tests ±0  656 ✔️ ±0  0 💤 ±0  0 ❌ ±0 
696 runs  ±0  696 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 0cfdde4. ± Comparison against base commit 7bc38a3.

Alenar
Alenar approved these changes Aug 9, 2023
View reviewed changes
Copy link
Collaborator

@Alenar Alenar left a comment

Choose a reason for hiding this comment

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

LGTM

@jpraynaud jpraynaud merged commit 45c1368 into main Aug 9, 2023
@jpraynaud jpraynaud deleted the jpraynaud/1085-reorganize-docs-folder branch August 9, 2023 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Alenar Alenar Alenar approved these changes

Assignees

@jpraynaud jpraynaud

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jpraynaud @Alenar