Skip to content

Commit

Permalink
updates and Antora Versioning Solutions
Browse files Browse the repository at this point in the history
  • Loading branch information
mustafaokyay committed Feb 21, 2022
1 parent 9e80049 commit 7a7cd32
Show file tree
Hide file tree
Showing 169 changed files with 67,532 additions and 0 deletions.
22 changes: 22 additions & 0 deletions Antora_Versioning_Methods.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
== Antora Versioning Methods
Antora basically has three different solutions for versioning which can be summarized as follows:

=== Folders
If we were to use version folders to store documentation versions all in a single branch, then we would have to explicitly copy all the files in a version to a new folder to create a new version. In doing so, we would no longer be able to rely on git to compare, manage, and merge different versions of the same document.

This method does not meet our requirements!

=== Tags
If we were to use tags to store documentation versions, then we would not be able to update the documentation once the tag was made, effectively freezing the documentation from receiving updates.

This method does not meet our requirements!

=== Branches
Using this method, you store each documentation version in a branch of a git repository, just like you use branches to store version lines of a software project.

You then set the https://docs.antora.org/antora/latest/playbook/content-branches/[branches key] on the content source to tell Antora which branches to use. The name of the branch itself does not matter. It is the https://docs.antora.org/antora/latest/component-version-key/[version key] in the https://docs.antora.org/antora/latest/component-version-descriptor/[component version descriptor] or playbook that determines the version.
Branches are ideally suited for managing multiple versions of the same content.

== Conclusion
Using Branches for versioning seems to offer the only possible solution for our needs. By creating a new branch from an existing reference in the repository to hold a new version, the repository only stores what is changed since that branch point. And that branch can receive updates at any time. That is what git does best.
Branches map well to the system of references provided by git and are flexible enough to allow documentation to be updated freely.
3 changes: 3 additions & 0 deletions build/site/_/css/site.css

Large diffs are not rendered by default.

Binary file added build/site/_/font/roboto-latin-400.woff
Binary file not shown.
Binary file added build/site/_/font/roboto-latin-400.woff2
Binary file not shown.
Binary file added build/site/_/font/roboto-latin-400italic.woff
Binary file not shown.
Binary file added build/site/_/font/roboto-latin-400italic.woff2
Binary file not shown.
Binary file added build/site/_/font/roboto-latin-500.woff
Binary file not shown.
Binary file added build/site/_/font/roboto-latin-500.woff2
Binary file not shown.
Binary file added build/site/_/font/roboto-latin-500italic.woff
Binary file not shown.
Binary file added build/site/_/font/roboto-latin-500italic.woff2
Binary file not shown.
Binary file added build/site/_/font/roboto-mono-latin-400.woff
Binary file not shown.
Binary file added build/site/_/font/roboto-mono-latin-400.woff2
Binary file not shown.
Binary file added build/site/_/font/roboto-mono-latin-500.woff
Binary file not shown.
Binary file added build/site/_/font/roboto-mono-latin-500.woff2
Binary file not shown.
1 change: 1 addition & 0 deletions build/site/_/img/back.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions build/site/_/img/caret.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions build/site/_/img/chevron.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions build/site/_/img/home-o.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions build/site/_/img/home.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions build/site/_/img/menu.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions build/site/_/img/octicons-16.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions build/site/_/js/site.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions build/site/_/js/vendor/highlight.js

Large diffs are not rendered by default.

Loading

0 comments on commit 7a7cd32

Please sign in to comment.