DBZ-1687 DBZ-1729 Consolidate attributes, Antora process clean-up #1224
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
This was referenced Jan 23, 2020
gunnarmorling
requested changes
Jan 27, 2020
DOCUMENTATION.md
Outdated
|
|
||
| The general rule is if an attribute changes frequently or is related to a specific version or subset of versions of Debezium, it likely belongs in the `antora.yml` file in this repository. If the attribute changes infrequent or is not specific to a given version of Debezium, its easier to maintain that in the various playbook files in the Debezium website repository. | ||
|
|
||
| Lets say we need to add an attribute that points to our JIRA issue for issue links, that would be an example of an attrbute that would be defined in the playbook. But if we needed to add an attribute that points to a specific version of a naven artifact or reference a specific version of a dependency, that's more appropriate for the `antora.yml` component descriptor located in this repository. |
There was a problem hiding this comment.
Suggested change
| Lets say we need to add an attribute that points to our JIRA issue for issue links, that would be an example of an attrbute that would be defined in the playbook. But if we needed to add an attribute that points to a specific version of a naven artifact or reference a specific version of a dependency, that's more appropriate for the `antora.yml` component descriptor located in this repository. | |
| Lets say we need to add an attribute that points to our JIRA issue for issue links, | |
| that would be an example of an attrbute that would be defined in the playbook. | |
| But if we needed to add an attribute that points to a specific version of a Maven artifact or reference a specific version of a dependency, | |
| that's more appropriate for the `antora.yml` component descriptor located in this repository. |
There was a problem hiding this comment.
Fixed a typo (naven) and also changed to "one thought per line" wrapping style. Let's stick to that for easier diffing in case of future changes.
DOCUMENTATION.md
Outdated
|
|
||
| * _attributes.adoc | ||
| * antora.yml | ||
| The `antora.yml` file in the `master` branch always uses version called _master_. It is important right before a release when applying the change log and contributor changes to modify this file to reference the correct major and minor version. It's also important to make any necessary changes to version-specific attributes in this file at the same time. |
There was a problem hiding this comment.
Same as above: can you change to one thought/sentence per line, avoiding super-long lines? Thanks!
DOCUMENTATION.md
Outdated
|
|
||
| ### Attributes | ||
| So when releasing version 2.1 as an example, change `antora.yml` from: |
There was a problem hiding this comment.
That would better go to the release procedure document.
* Typos and formatting changes. * Moved release procedure steps from DOCUMENTATION.md to RELEASING.md.
| @@ -30,6 +30,21 @@ It currently exists in two versions, one in the main code repo and one on the we | |||
| JIRA issues that break backwards compatability for existing consumers, should be marked with the "add-to-upgrade-guide" label. | |||
| Search for them using [this query](https://issues.jboss.org/issues/?jql=labels%20%3D%20add-to-upgrade-guide) and describe the implications and required steps for upgrading in the changelog on the website. | |||
|
|
|||
| ## Update antora.yml | |||
There was a problem hiding this comment.
@jpechane, are you aware of this procedure?
|
Nice improvement, merging. Let's stick to the "one sentence/thought per line" rule even more strictly going forward. Thanks! |
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.
This PR covers documentation action items outlined in the following two issues:
https://issues.redhat.com/browse/DBZ-1687
https://issues.redhat.com/browse/DBZ-1729