Skip to content

Commit

Permalink
Fix whitespace control in README generation (#452)
Browse files Browse the repository at this point in the history
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.

Part of stackabletech/issues#492
  • Loading branch information
lfrancke authored Jan 10, 2024
1 parent 1d2c835 commit 423dc46
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 6 deletions.
21 changes: 16 additions & 5 deletions .readme/README.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,22 @@
{%- set operator_docs_slug="hdfs" -%}
{%- set related_reading_links=[] -%}

{% include "partials/borrowed/header.md.j2" %}
{% include "partials/borrowed/links.md.j2" %}
{% filter trim %}
{%- include "partials/borrowed/header.md.j2" -%}
{% endfilter %}

{% include "partials/main.md.j2" %}
{% filter trim %}
{%- include "partials/borrowed/links.md.j2" -%}
{% endfilter %}

{% include "partials/borrowed/footer.md.j2" %}
{% filter trim %}
{%- include "partials/main.md.j2" -%}
{% endfilter %}

{% include "partials/borrowed/related_reading.md.j2" %}
{% filter trim %}
{%- include "partials/borrowed/footer.md.j2" -%}
{% endfilter %}

{% filter trim %}
{%- include "partials/borrowed/related_reading.md.j2" -%}
{% endfilter %}
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[workspace]
members = ["rust/crd", "rust/operator-binary"]
resolver = "2"

[workspace.package]
version = "0.0.0-dev"
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ The documentation for all Stackable products can be found at [docs.stackable.tec

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).


## About The Stackable Data Platform

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

0 comments on commit 423dc46

Please sign in to comment.