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

Define variables in md language instead of having to update it in multiple places for every documentation update #425

Closed
danielvegamyhre opened this issue Feb 13, 2024 · 9 comments · Fixed by #540
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.

Comments

@danielvegamyhre
Copy link
Contributor

Define variables in md language instead of having to update it in multiple places for every documentation update

@danielvegamyhre danielvegamyhre added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Feb 13, 2024
@uroy-personal
Copy link

/assign

@uroy-personal
Copy link

Hi @danielvegamyhre ,
I am interested to work on this. Could you please provide more info on the change. An implementation example will also help.
I see four md files in the project ( README.md, RELEASE.md, SECURITY.md & CONTRIBUTING.md ), Do I need to created additional md files? Thanks.

@danielvegamyhre
Copy link
Contributor Author

This is primarily about https://github.com/kubernetes-sigs/jobset/blob/main/docs/setup/install.md where we want the VERSION to be a MD variable, rather than needing to change it in several places.

@uroy-personal
Copy link

Hi @danielvegamyhre ,
I see the above file path does not exist. Should I check https://jobset.sigs.k8s.io/docs/installation file and put the md variable for VERSION if it is not present at the moment? Please advise. Thanks.

@danielvegamyhre
Copy link
Contributor Author

Yes we moved all the docs into the site/content/en directory.

@googs1025
Copy link
Member

/assign @danielvegamyhre can i try this?

@danielvegamyhre
Copy link
Contributor Author

Sure go ahead, that would be helpful

@uroy-personal
Copy link

Sorry guys. Having bit of hectic times recently. Unassigning it for the time-being. Will look foreward to this repo for future work scopes.

@uroy-personal uroy-personal removed their assignment Apr 19, 2024
@googs1025
Copy link
Member

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants