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

docs: Remove embedmd in examples and mixin #4587

Merged
merged 1 commit into from
Aug 24, 2021

Conversation

saswatamcode
Copy link
Member

  • I added CHANGELOG entry for this change.
  • Change is not relevant to the end user.

Changes

This PR removes embedmd and shifts to mdox for markdown content present in examples and mixin. Also removes genflagdocs.sh as its functionality has been replaced in #4357.

Open question: Should Examples and Mixin docs be added to the website sidebar, as currently they can only be referenced through GitHub? 🙂

Verification

Tested locally.

Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>
@Namanl2001
Copy link
Contributor

Should Examples and Mixin docs be added to the website sidebar?

IMHO yes, because there are some pages on the website that reference examples and Mixin docs so instead of hardcoding the GitHub links and redirecting them to Github we can have separate sections for them on the website itself. And I guess it would be a better experience to have everything in one place.

Let's wait for some maintainers' review on this. thanks

Copy link
Member

@bwplotka bwplotka left a comment

Choose a reason for hiding this comment

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

Sweet, thanks!

@bwplotka
Copy link
Member

Do we want to add them in this PR or next?

@saswatamcode
Copy link
Member Author

Will handle in next PR! 🙂

@bwplotka bwplotka merged commit 8ab7fa2 into thanos-io:main Aug 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants