Components Rendering: Support nested readmes #609
Merged
Conversation
This file contains 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
Benbentwo
commented
May 2, 2024
| github_edit_url = f"https://github.com/{GITHUB_REPO}/blob/master/modules/{relative_path}" | ||
|
|
||
| if len(relative_path.split('/')) > 2: # this is submodule | ||
| if len(relative_path.split('/')) > 2 and relative_path.split('/')[1] != 'docs' : # this is submodule |
There was a problem hiding this comment.
This smells. Though I'm not sure how we want to handle this, we need to enforce either docs/ or modules but think of tgw which uses tgw/hub as a component, it is nested, therefore I stuck with docs as an exception to the rule (where it's not a directory of TF)
milldr
reviewed
May 2, 2024
Comment on lines
+46
to
+47
| - name: "Benjamin Smith" | ||
| github: "Benbentwo" |
There was a problem hiding this comment.
FYI this doesnt do anything. Contributors are pulled from contribs. But doesnt hurt either
There was a problem hiding this comment.
(with the updated README template)
There was a problem hiding this comment.
Yeah added mostly to trigger a build
milldr
approved these changes
May 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
what
docs/some-doc.mdwhy
cloudposse-componentsGitHub organization.