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

Docs versioning #1008

Merged
merged 9 commits into from
Nov 3, 2023
Merged

Docs versioning #1008

merged 9 commits into from
Nov 3, 2023

Conversation

jamesmunro
Copy link
Collaborator

@jamesmunro jamesmunro commented Oct 29, 2023 •
edited
Loading

Add mike to version the documentation.

mike docs are deployed to docs-pages branch from where they are published to cloudflare.
Normally you would use gh-pages branch, but we are already using that for asv.

The workflows are still manual at the moment. Will automate next.

image

poodlewars
poodlewars reviewed Oct 30, 2023
View reviewed changes
Copy link
Collaborator

@poodlewars poodlewars left a comment

Choose a reason for hiding this comment

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

The screenshot in the description looks quite messy, with the versions list hanging over the header? And how will it look when we have dozens of versions?

278901080-15db9db5-11c3-475a-9ea1-8e234bc417fb

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
qc00
qc00 reviewed Oct 30, 2023
View reviewed changes
.github/workflows/docs_build.yml Outdated Show resolved Hide resolved
.github/workflows/docs_build.yml Show resolved Hide resolved
.github/workflows/docs_build.yml Outdated Show resolved Hide resolved
@jamesmunro
Copy link
Collaborator Author

It's a drop down which I've clicked in the screenshot.

The screenshot in the description looks quite messy, with the versions list hanging over the header? And how will it look when we have dozens of versions?

278901080-15db9db5-11c3-475a-9ea1-8e234bc417fb

@qc00
Copy link
Contributor

qc00 commented Oct 30, 2023

Also needs to update https://github.com/man-group/ArcticDB/blob/master/.github/workflows/README.md

@jamesmunro
Copy link
Collaborator Author

Also needs to update https://github.com/man-group/ArcticDB/blob/master/.github/workflows/README.md

Done.

poodlewars
poodlewars approved these changes Nov 1, 2023
View reviewed changes
.github/workflows/README.md Outdated Show resolved Hide resolved
docs/mkdocs/docs/technical/releasing.md Outdated Show resolved Hide resolved
jamesmunro and others added 9 commits November 2, 2023 14:09
@jamesmunro
Versioned docs
27407c4
@jamesmunro
Versioned docs
d922475
@jamesmunro
Docs versioning
6bb1cf2
@jamesmunro @poodlewars
Update docs/README.md fix type
b538d3c 
Co-authored-by: Alex Seaton <alexbseaton_github@proton.me>
@jamesmunro
Versioned docs
68799c4
@jamesmunro
Versioned docs
a1380c8
@jamesmunro @poodlewars
Update .github/workflows/README.md
391f945 
Co-authored-by: Alex Seaton <alexbseaton@gmail.com>
@jamesmunro @poodlewars
Update docs/mkdocs/docs/technical/releasing.md
465679a 
Co-authored-by: Alex Seaton <alexbseaton@gmail.com>
@jamesmunro
Update README.md
6413f79
@jamesmunro jamesmunro self-assigned this Nov 2, 2023
@jamesmunro jamesmunro merged commit d92eae3 into master Nov 3, 2023
97 checks passed
@jamesmunro jamesmunro deleted the docs-versioning branch November 3, 2023 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qc00 qc00 qc00 approved these changes

@poodlewars poodlewars poodlewars approved these changes

@alexowens90 alexowens90 Awaiting requested review from alexowens90

@willdealtry willdealtry Awaiting requested review from willdealtry

Assignees

@jamesmunro jamesmunro

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jamesmunro @qc00 @poodlewars