Docs: Fix rendering {{.RepoName}} in generated samplerepo markdown#10233
Open
jere357 wants to merge 1 commit into
Open
Docs: Fix rendering {{.RepoName}} in generated samplerepo markdown#10233jere357 wants to merge 1 commit into
jere357 wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #NaN
Change Description
Small samplerepo markdown template rendering fix
Background
I encountered this markdown rendering bug when i created my first lakefs repository and decided to add the sample data, hooks, and configuration stuff.
The first 4 chapters correctly rendered my repository name as test-repo-1, meaning the rendered commands were correctly written as
lakefs://test-repo1/main.In the Configuring the actions chapter the templated commands fell back to
lakefs://quickstart/add_actionwhich is incorrect.Some tokens later i located the markdown template and changed it so that it correctly renders your .RepoName in that chapter + testing the action chapter as well.
Bug Fix
In the
pkg/samplerepo/assets/sample/README.md.tmplConfiguring the actions + testing the action chapter.Changed hardcoded quickstart string to {{.RepoName}} to mimic behavior/templating from the chapters that come before it.
How were the changes tested?
i locally rendered the markdowns and it made sense to me