Updating documentation #15
Conversation
README.md
Outdated
|
|
||
| ## **Primary Catalog YAML File** | ||
|
|
||
| If you wish to make adjustments based on the `auto-generated-catalog.yml` file, you can do so by: |
There was a problem hiding this comment.
Rephrasing suggestion:
If you wish to make adjustments to the 'auto-generated-catalog.yml' file, you'll need to create a 'catalog.yml' file in the root folder of your repository.
There was a problem hiding this comment.
Should there be a suggestion to leave out the ID field?
There was a problem hiding this comment.
ID field can be included, or left out, same as all the other variables. I think I'd prefer adding that information in the readme to avoid people thinking they have to specificy and make the whole file.
README.md
Outdated
|
|
||
| If you wish to make adjustments based on the `auto-generated-catalog.yml` file, you can do so by: | ||
|
|
||
| - Creating a new `catalog.yml` file in the root of your repository and including only the modifications you want. |
There was a problem hiding this comment.
Leave out the suggestions to copy or start from scratch.
There was a problem hiding this comment.
Left that out
README.md
Outdated
|
|
||
| ## **Primary Catalog YAML File** | ||
|
|
||
| If you wish to make adjustments based on the `auto-generated-catalog.yml` file, you can do so by: |
There was a problem hiding this comment.
ID field can be included, or left out, same as all the other variables. I think I'd prefer adding that information in the readme to avoid people thinking they have to specificy and make the whole file.
README.md
Outdated
|
|
||
| If you wish to make adjustments based on the `auto-generated-catalog.yml` file, you can do so by: | ||
|
|
||
| - Creating a new `catalog.yml` file in the root of your repository and including only the modifications you want. |
There was a problem hiding this comment.
Left that out
No description provided.