Misc. updates
This commit is contained in:
parent
9b27f8a383
commit
463ee138a4
@ -2,12 +2,23 @@
|
|||||||
|
|
||||||
The Debezium documentation in [documentation](https://github.com/debezium/debezium/tree/master/documentation) is built using the [Antora Framework](https://www.antora.org).
|
The Debezium documentation in [documentation](https://github.com/debezium/debezium/tree/master/documentation) is built using the [Antora Framework](https://www.antora.org).
|
||||||
|
|
||||||
* [Antora Quickstart](#quick-start)
|
- [Antora Quickstart](#antora-quickstart)
|
||||||
* [What to change _after_ releasing new version](#release)
|
- [Component descriptors](#component-descriptors)
|
||||||
* [Contributing to the Documentation](#contributing)
|
- [Page content](#page-content)
|
||||||
|
- [Linking to content](#linking-to-content)
|
||||||
|
- [External](#external)
|
||||||
<div id='quick-start'></div>
|
- [Internal](#internal)
|
||||||
|
- [Navigation Pane](#navigation-pane)
|
||||||
|
- [Antora Configuration](#antora-configuration)
|
||||||
|
- [Attributes](#attributes)
|
||||||
|
- [What to change _after_ releasing new version](#what-to-change-_after_-releasing-new-version)
|
||||||
|
- [Attributes](#attributes-1)
|
||||||
|
- [Antora YAML](#antora-yaml)
|
||||||
|
- [Contributing to the Documentation](#contributing-to-the-documentation)
|
||||||
|
- [Using AsciiDoc attributes](#using-asciidoc-attributes)
|
||||||
|
- [Cross references](#cross-references)
|
||||||
|
- [Adding images](#adding-images)
|
||||||
|
- [Best practices](#best-practices)
|
||||||
|
|
||||||
## Antora Quickstart
|
## Antora Quickstart
|
||||||
|
|
||||||
@ -103,8 +114,6 @@ The current attributes file looks similar to the following:
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
<div id='release'></div>
|
|
||||||
|
|
||||||
## What to change _after_ releasing new version
|
## What to change _after_ releasing new version
|
||||||
|
|
||||||
It's important that 2 files be properly maintained after the repository transitions between releases
|
It's important that 2 files be properly maintained after the repository transitions between releases
|
||||||
@ -120,8 +129,6 @@ Whenever any release is made, its important that the `_attributes.adoc` file [he
|
|||||||
|
|
||||||
The antora component descriptor file, `antora.yml` only needs to be updated when the next anticipated release will be a new major or minor. Since documentation is maintained using a `<MAJOR>.<MINOR>` scheme, this file would only be changed when transitioning from version _0.9_ to _0.10_ or _1.1_ to _2.0_ as an example.
|
The antora component descriptor file, `antora.yml` only needs to be updated when the next anticipated release will be a new major or minor. Since documentation is maintained using a `<MAJOR>.<MINOR>` scheme, this file would only be changed when transitioning from version _0.9_ to _0.10_ or _1.1_ to _2.0_ as an example.
|
||||||
|
|
||||||
<div id='contributing'></div>
|
|
||||||
|
|
||||||
## Contributing to the Documentation
|
## Contributing to the Documentation
|
||||||
|
|
||||||
Follow these guidelines for contributing to the Debezium documentation.
|
Follow these guidelines for contributing to the Debezium documentation.
|
||||||
@ -177,3 +184,8 @@ Note the following additional recommendations:
|
|||||||
|
|
||||||
* If your contribution also involves reformatting large amounts of text (modifying white space, line breaks, and so on), please make these reformatting updates in a _separate_ commit.
|
* If your contribution also involves reformatting large amounts of text (modifying white space, line breaks, and so on), please make these reformatting updates in a _separate_ commit.
|
||||||
It is much easier for reviewers to focus on the technical changes in the content, if commits are not polluted by large amounts of trivial formatting changes.
|
It is much easier for reviewers to focus on the technical changes in the content, if commits are not polluted by large amounts of trivial formatting changes.
|
||||||
|
* Avoid long lines for the sake of simpler diffs;
|
||||||
|
instead of sticking to a hard character number limit,
|
||||||
|
put one sentence or line of thought per line.
|
||||||
|
It's not a black-or-white rule, but it works surprisingly well after getting used to it.
|
||||||
|
E.g. commas are a good indicator for moving to a new line.
|
||||||
|
@ -463,7 +463,6 @@ When we compare this to the value in the _insert_ event, we see a couple of diff
|
|||||||
====
|
====
|
||||||
The content of the patch field is provided by MongoDB itself and its exact format depends on the specific database version.
|
The content of the patch field is provided by MongoDB itself and its exact format depends on the specific database version.
|
||||||
You should therefore be prepared for potential changes to the format when upgrading the MongoDB instance to a new version.
|
You should therefore be prepared for potential changes to the format when upgrading the MongoDB instance to a new version.
|
||||||
The content of the `patch` field is provided by MongoDB itself and its exact format depends on the version.
|
|
||||||
|
|
||||||
All examples in this document were obtained from MongoDB 3.4 and might differ if you use a different one.
|
All examples in this document were obtained from MongoDB 3.4 and might differ if you use a different one.
|
||||||
====
|
====
|
||||||
|
Loading…
Reference in New Issue
Block a user