Skip to content

docs: add footer with CNCF trademark notice #1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Mar 11, 2025
Merged

docs: add footer with CNCF trademark notice #1186

merged 1 commit into from
Mar 11, 2025

Conversation

jmarrero
Copy link
Contributor

No description provided.

@github-actions github-actions bot added documentation Improvements or additions to documentation control/skip-ci Do not run expensive CI on this job labels Mar 10, 2025
@jeckersb
Copy link
Collaborator

I'm not seeing the footer anywhere in the built docs. I don't think that footer is valid for the html backend? See https://rust-lang.github.io/mdBook/format/configuration/renderers.html#html-renderer-options.

I do see there's an embedify preprocessor that knows how to do footer insertion though - https://mr-addict.github.io/mdbook-embedify/local/footer.html

@jmarrero jmarrero force-pushed the cncf-footer branch 2 times, most recently from d510b54 to 6fadc9b Compare March 11, 2025 00:47
@jmarrero
Copy link
Contributor Author

I'm not seeing the footer anywhere in the built docs. I don't think that footer is valid for the html backend? See https://rust-lang.github.io/mdBook/format/configuration/renderers.html#html-renderer-options.

I do see there's an embedify preprocessor that knows how to do footer insertion though - https://mr-addict.github.io/mdbook-embedify/local/footer.html

yeah that is why is draft. But the current diff adds it. I am not thrilled on how it looks.

@jmarrero
Copy link
Contributor Author

Maybe adding a centralized --- before that line would make it clear is not part of the doc text.

@jmarrero
docs: add footer with CNCF trademark notice
5229fbb 
Signed-off-by: Joseph Marrero Corchado <jmarrero@redhat.com>
@jmarrero jmarrero marked this pull request as ready for review March 11, 2025 01:00
@jmarrero
Copy link
Contributor Author

ok, now I like how it looks and actually works.

jeckersb
jeckersb approved these changes Mar 11, 2025
View reviewed changes
Copy link
Collaborator

@jeckersb jeckersb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

cgwalters
cgwalters approved these changes Mar 11, 2025
View reviewed changes
docs/book.toml
[preprocessor.header-footer]
headers = []
footers = [
{ padding = "\n---\n<p style=\"font-size:11px\">The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see <a href=\"https://www.linuxfoundation.org/trademark-usage/\">Trademark Usage.</a></p>" }
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This HTML-in-TOML is a bit syntactically awkward, but I guess there's nothing we can do about that.

@cgwalters cgwalters merged commit 8e32773 into bootc-dev:main Mar 11, 2025
6 checks passed
@jmarrero jmarrero mentioned this pull request May 12, 2025
Open
31 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeckersb jeckersb jeckersb approved these changes

@cgwalters cgwalters cgwalters approved these changes

Assignees
No one assigned
Labels
control/skip-ci Do not run expensive CI on this job documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jmarrero @jeckersb @cgwalters