Skip to content
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.

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

GenMarkdownTreeCustom doesn't have a way to append a footer #1140

Open
poy opened this issue Jun 16, 2020 · 6 comments · Fixed by #1270
Open

GenMarkdownTreeCustom doesn't have a way to append a footer #1140

poy opened this issue Jun 16, 2020 · 6 comments · Fixed by #1270
Labels
good-first-issue Issues that a new contributor could make a PR for kind/documentation Documentation of cobra itself

Comments

@poy
Copy link

poy commented Jun 16, 2020

GenMarkdownTreeCustom has a way to a header (filePrepender arg), however there is not a first class way to add a footer.

@jpmcb
Copy link
Collaborator

jpmcb commented Aug 10, 2020

Hi there @poy thanks for opening this issue and contributing!

I believe you are correct, there is no way to add a footer to generated documentation. Can I ask what use case you have for adding a footer to generated documentation? In general, the generated documentation is simply the output of the various "help" messages provided by cobra commands.

@poy
Copy link
Author

poy commented Aug 17, 2020

We need a way to add something similar to how many websites have their trademark and disclaimers near the bottom of the page. For example, looking at GCS docs, if you look at the bottom of the page you'll see:

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

This is on every docs page for cloud.google.com.

@jpmcb jpmcb added kind/documentation Documentation of cobra itself good-first-issue Issues that a new contributor could make a PR for labels Aug 18, 2020
@jpmcb
Copy link
Collaborator

jpmcb commented Aug 18, 2020

I see - I think that adding a footer makes sense. If you'd (or anyone in the community) would like to open a PR for this, feel free to tag me and I'll review!! 🚀

@stuckinforloop
Copy link

Hey guys I am looking forward to work on this issue. I really want to take the benefit of the hacktoberfest and this may work.

@github-actions
Copy link

This issue is being marked as stale due to a long period of inactivity

@jpmcb
Copy link
Collaborator

jpmcb commented Jan 25, 2021

Re-opening as #1270 had some overlooked breaking changes.

@sonjoonho thanks so much for that PR, if you'd like to take another look and open a new PR, feel free to! Let's avoid any breaking changes in the next pass and I'll keep a closer eye out for it as well

Cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good-first-issue Issues that a new contributor could make a PR for kind/documentation Documentation of cobra itself
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants