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

Fix numbering in README.MD #1969

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

malopez16
Copy link

No description provided.

Copy link

hashicorp-cla-app bot commented Jul 26, 2024

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes


1 out of 2 committers have signed the CLA.

  • blake
  • malopez16

Have you signed the CLA already but the status is still pending? Recheck it.

Comment on lines -81 to +83
1. Extract the binary using `unzip` or `tar`.
2. Extract the binary using `unzip` or `tar`.

1. Move the binary into `$PATH`.
3. Move the binary into `$PATH`.
Copy link
Member

Choose a reason for hiding this comment

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

It's okay to use 1. for every item in a list when using Markdown. The items will be correctly numbered when the document is rendered. See https://github.com/hashicorp/consul-template?tab=readme-ov-file#installation .

README.md Outdated
Comment on lines 100 to 102
```liquid
{{ key "foo" }}
```
Copy link
Member

Choose a reason for hiding this comment

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

These code blocks need to be indented by one more space in order for the markdown parser to correctly recognize that they belong to the parent list item and retain the sequential numbering when rendering the doc.

Suggested change
```liquid
{{ key "foo" }}
```
```liquid
{{ key "foo" }}

README.md Outdated
1. Author a template `in.tpl` to query the kv store:
2. Author a template `in.tpl` to query the kv store:
Copy link
Member

Choose a reason for hiding this comment

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

These should be changed back to using 1. as the item's number in the list.

@blake blake added the docs label Sep 26, 2024
@blake
Copy link
Member

blake commented Sep 26, 2024

Hi @malopez16, I made a couple of changes to this PR. I will be able to merge it after you sign the required CLA.

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants