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

Docs/release/23.2 #18

Merged
merged 7 commits into from
Nov 6, 2023
Merged

Docs/release/23.2 #18

merged 7 commits into from
Nov 6, 2023

Conversation

odzhychko
Copy link
Contributor

@odzhychko odzhychko commented Nov 3, 2023

This PR fixes the links in the documentation.

To achieve that, I created separate release branches (eg. docs/release/...) for documentation in each repository.

Compared to the previous tags, they have a name, that indicates a documentation release (eg. new docs/release/23.2 vs. old modelix-23.2).

Those documentation release branches can be fixed independently without modifying the release tag, which indicates the version of the software. (That is what I needed to do, to make the documentation build)

We could also use documentation release tags, if you see a reason for it. Personally, I agreed with Antoras statement about the drawbacks of tags for releases:

The downside of tags is that, once created, you can’t update them like you can with branches. So, if you find a typo, or need to add an example, you can’t edit the content in a tag. It’s frozen. You’d have to delete and recreate the tag, or create a new tag and point to it, in order to publish your updates.

See https://docs.antora.org/antora/latest/content-source-versioning-methods/#version-content-using-tags

Related

It relates to and should be merged after:

It relates to newly created, branches that can be reviewed, but do not need to be merged:

Side notes

Regarding this topic, I added two points to our weekly:

  1. Do we want to publish docs for older versions 23.0 and 23.1?
  2. Where do we want to document details about the structure of the documentation setup?

@odzhychko
Copy link
Contributor Author

The failing build can be ignored until we merge the pull requests in the individual components.

@odzhychko
Copy link
Contributor Author

The build is failing. It seems to be the case, because it uses the main branch from modelix.docs. I'm looking into it.

@odzhychko odzhychko merged commit 1efbc8f into main Nov 6, 2023
1 check passed
@odzhychko odzhychko deleted the docs/release/23.2 branch November 6, 2023 10:06
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.

2 participants