Skip to content

Commit b56acf6

Browse files
Fix whitespace control in README generation (#437)
* docs: Add listener-operator where missing * Fix whitespace control in README generation So far we would include files with all their whitespace which can lead to markdownlint errors and inconsistencies. Now we trim everything we include. This also switches to resolver v2 for the workspace because the render-readme step would warn about it. --------- Co-authored-by: Siegfried Weber <mail@siegfriedweber.net>
1 parent 56d8ad9 commit b56acf6

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

.readme/README.md.j2

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,22 @@
33
{%- set operator_docs_slug="hbase" -%}
44
{%- set related_reading_links=[] -%}
55

6-
{% include "partials/borrowed/header.md.j2" %}
7-
{% include "partials/borrowed/links.md.j2" %}
6+
{% filter trim %}
7+
{%- include "partials/borrowed/header.md.j2" -%}
8+
{% endfilter %}
89

9-
{% include "partials/main.md.j2" %}
10+
{% filter trim %}
11+
{%- include "partials/borrowed/links.md.j2" -%}
12+
{% endfilter %}
1013

11-
{% include "partials/borrowed/footer.md.j2" %}
14+
{% filter trim %}
15+
{%- include "partials/main.md.j2" -%}
16+
{% endfilter %}
1217

13-
{% include "partials/borrowed/related_reading.md.j2" %}
18+
{% filter trim %}
19+
{%- include "partials/borrowed/footer.md.j2" -%}
20+
{% endfilter %}
21+
22+
{% filter trim %}
23+
{%- include "partials/borrowed/related_reading.md.j2" -%}
24+
{% endfilter %}

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
members = [
33
"rust/crd", "rust/operator-binary"
44
]
5+
resolver = "2"
56

67
[workspace.package]
78
version = "0.0.0-dev"

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ The documentation for all Stackable products can be found at [docs.stackable.tec
3434

3535
If you have a question about the Stackable Data Platform contact us via our [homepage](https://stackable.tech/) or ask a public questions in our [Discussions forum](https://github.com/orgs/stackabletech/discussions).
3636

37-
3837
## About The Stackable Data Platform
3938

4039
This operator is written and maintained by [Stackable](https://stackable.tech) and it is part of a larger data platform.

0 commit comments

Comments
 (0)