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

Improve embed function for docs #2363

Closed
2 tasks
RealAnna opened this issue Oct 30, 2023 · 2 comments
Closed
2 tasks

Improve embed function for docs #2363

RealAnna opened this issue Oct 30, 2023 · 2 comments
Labels
docs-infrastructure Issues related to the look and feel of the docs enhancement New feature or request
Milestone

Comments

@RealAnna
Copy link
Contributor

RealAnna commented Oct 30, 2023

this function here embeds yaml files from a branch but requires the files to already exist in the branch to work.

This is needed for file outside of the docs since they won't be copyied in the docker container that generates the doc website. However for those yaml file in the docs folder, eg here we should be able to use relative paths so that one can add the file in the same pr it is embedded.

AC

@RealAnna RealAnna added documentation Improvements or additions to documentation enhancement New feature or request status: ready-for-refinement Issue is relevant for the next backlog refinment labels Oct 30, 2023
@RealAnna RealAnna changed the title improve embed function for docs Improve embed function for docs Oct 30, 2023
@RealAnna RealAnna added docs-infrastructure Issues related to the look and feel of the docs and removed documentation Improvements or additions to documentation labels Oct 30, 2023
@mowies mowies added this to the 0.9 milestone Oct 30, 2023
@thisthat
Copy link
Member

thisthat commented Nov 6, 2023

with #2398, a new shortcode has been introduced docsembed

@mowies mowies modified the milestones: 0.9, 0.10 Nov 6, 2023
@mowies mowies removed the status: ready-for-refinement Issue is relevant for the next backlog refinment label Nov 15, 2023
@mowies
Copy link
Member

mowies commented Nov 15, 2023

The team agreed to close this since 2 separate shortcodes are good enough for now.

@mowies mowies closed this as not planned Won't fix, can't repro, duplicate, stale Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-infrastructure Issues related to the look and feel of the docs enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

3 participants