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.

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

Add subpath support for published docs #54

Merged
merged 7 commits into from
Aug 8, 2022
Merged

Add subpath support for published docs #54

merged 7 commits into from
Aug 8, 2022

Conversation

adierkens
Copy link
Member

@adierkens adierkens commented Aug 6, 2022

Fixes: #47

Re-organizes how the docs site is merged together. Now creates a .tar.gz of the full merged site, stamps that result to a new .tar.gz, and uploads that to github-pages.

The merged .tar.gz is stamped twice depending on it's output directory (/latest, /next, /<version>)

Version Selection

Adds a menu selection for latest, next and any released version

CleanShot 2022-08-08 at 11 05 32

Version

Published prerelease version: 0.1.1-next.1

Changelog

🐛 Bug Fix

  • Add subpath support for published docs #54 (@adierkens)
  • enhance error state deserialization & stacktrace logging in player view model #50 (@sugarmanz)

📝 Documentation

Authors: 4


const data = await response.json();
const versions = data
.filter((d) => d.type === 'dir' && d.name.match(/^v\d$/))
Copy link
Member

@KetanReddy KetanReddy Aug 8, 2022

Choose a reason for hiding this comment

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

Shouldn't this regex match any name that is a valid semvar version or are we organizing the docs folders differently?

Copy link
Member Author

Choose a reason for hiding this comment

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

The docs are published by major -- so v0, v1, etc
I should fix it to handle vXX though

Copy link
Member Author

Choose a reason for hiding this comment

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

The release folder is determined from

SEMVER_MAJOR=$(cat VERSION | cut -d. -f1)

Copy link
Member

@KetanReddy KetanReddy Aug 8, 2022

Choose a reason for hiding this comment

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

Yeah, minor/patch versions were going to be my followup question. Also not sure where we landed on publishing docs for release candidates and canaries.

Copy link
Member Author

Choose a reason for hiding this comment

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

Anything merged to main (effectively an RC) goes under next -- we don't have anything for PR canaries yet

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs Infra Improvements
2 participants