-
Notifications
You must be signed in to change notification settings - Fork 740
docs: Merge gh-pages commits into main #2546
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
Conversation
@vnikolova Let me know if you think there'd be any issue with the html redirect files being moved to |
@e5l I noticed when pushing directly to I'm assuming that, moving forward, we will want to only trigger this action manually with a release, not every time a commit is merged to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bog-walk The changes in the documentation-website
folder need to be reverted to match what is on the main
branch (cfg/buildprofiles.xml
and hi.tree
). These changes are not necessary anymore as GH pages should only use the static files from the docs
folder.
@vnikolova we're going to drop gh-pages and use main as target documentation branch instead to simplify API docs publishing |
- State on branch should now be equivalent to documentation-website folder on main
92ac81f
to
130694b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good 👍
Description
Summary of the change: Merge the 6 documentation commits made to
gh-pages
, which are missing onmain
.Detailed description:
Why: Documentation website redirects and API docs have been updated and deployed from
gh-pages
since around 0.58.0. So these files onmain
have not been updated since then. Part of the release process involves callingdokkaGenerate
onmain
, then copying-and-pasting a local copy ofdocs/api
togh-pages
directly each time.What:
gh-pages
that diverged frommain
Type of Change
Please mark the relevant options with an "X":