[WIP] doc: Make automatic deployment of versioned documentation possible #657
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tmadlener
commented
Aug 23, 2024
| @@ -62,13 +62,18 @@ deployment: | |||
| only: | |||
| refs: | |||
| - master | |||
| - versioned-docs | |||
There was a problem hiding this comment.
Suggested change
| - versioned-docs |
Leftover from testing / developing
tmadlener
commented
Aug 23, 2024
| - The `_contents` folder has to configured to have *Directory Browsing* enabled | ||
| since that will be used to determine the available versions (each top-level | ||
| folder in here will be considered a version). This is achieved via `echo | ||
| "Options +Indexes > _contents/.htaccess"` |
There was a problem hiding this comment.
Suggested change
| "Options +Indexes > _contents/.htaccess"` | |
| "Options +Indexes" > _contents/.htaccess"` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BEGINRELEASENOTES
ENDRELEASENOTES
This seems to be a bit convoluted, but I could not get any other version that claims to do automatic generation of versioned docs to work properly for podio, because they usually simply check out the repository for a given version and then do the doc generation from the code. However, we would need to run the build step again for each tag, which these tools don't do, plus it would get more expensive to do with every version. Hence, I went for a solution where we can simply add new content / tags and it will by picked up automatically.
It is possible to add older versions manually to this structure and new tags will simply be picked up automatically.
Overall the process is working and my playing around / testing can be tried here (the documentation is the same in both cases, it just shows how the version navigation looks like in the end).
There are a few assumptions in the dynamic determination of available versions, see the README for the gist of it.