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.

Sign up for GitHub

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

Jump to bottom

docs: Include minimal reference for templating mechanism #4122

Merged
merged 1 commit into from
Sep 29, 2020
Merged

docs: Include minimal reference for templating mechanism #4122

merged 1 commit into from
Sep 29, 2020

Conversation

YourPsychiatrist
Copy link
Contributor

@YourPsychiatrist YourPsychiatrist commented Sep 24, 2020 •
edited
Loading

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this is a chore.
  • The title of the PR is (a) conventional, (b) states what changed, and (c) suffixes the related issues number. E.g. "fix(controller): Updates such and such. Fixes #1234".
  • I've signed the CLA.

I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.

My builds are green. Try syncing with master if they are not.

@YourPsychiatrist
Copy link
Contributor Author

Someone pls help me out here I have no idea what that semantic pull request check wants from me. I just wanted to add some docs.

@alexec alexec changed the title Include minimal reference for templating mechanism docs: Include minimal reference for templating mechanism Sep 24, 2020
@alexec
Copy link
Contributor

alexec commented Sep 24, 2020

I think this would be a good time to create tip admonition, but unless you want to checkout the doc and run mkdocs serve you can really see result.

@YourPsychiatrist
Copy link
Contributor Author

I'll give that a try

@YourPsychiatrist
Copy link
Contributor Author

@alexec Please have a look, I think its a neat addition.

@alexec
Copy link
Contributor

alexec commented Sep 28, 2020

Could I please ask you to include a screenshot of the new page? That way we can check it renders correctly.

alexec
alexec reviewed Sep 28, 2020
View reviewed changes
mkdocs.yml
@@ -14,6 +14,8 @@ google_analytics:
markdown_extensions:
- codehilite
- admonition
- pymdownx.superfences
Copy link
Contributor

Choose a reason for hiding this comment

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

what is this please?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems as if this is needed so that admonitions can render code blocks. (The ones enclosed in triple backticks, formally referred to as a "code fence")

@alexec alexec self-assigned this Sep 28, 2020
@YourPsychiatrist
Copy link
Contributor Author

This is the new section with a collapsable (collapsed by default) reference + example.

Screenshot 2020-09-29 at 08 57 13

@alexec alexec merged commit 1e10e0c into argoproj:master Sep 29, 2020
@alexec
Copy link
Contributor

alexec commented Sep 29, 2020

Cool. Merging.

alexcapras pushed a commit to alexcapras/argo that referenced this pull request Nov 12, 2020
@YourPsychiatrist @alexcapras
Documentation (argoproj#4122)
ec4cb02 
Signed-off-by: Alex Capras <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alexec alexec alexec approved these changes

Assignees

@alexec alexec

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@YourPsychiatrist @alexec