Updates to the how-to guide for creating the config - #50
TeresiaOlsson wants to merge 15 commits into
Conversation
… also includes dictionary.
…nfiguration differs from building objects yourself.
…nfiguration explanation.
…e since the dictionary option also exist.
|
For me a how-to guide is how to set-up a minimal working exemple, so I would avoid adding too many advanced concept in this page, but rather adding new pages for these concepts. |
| ```{note} | ||
| Tools are available to help writing the configuration. See [Tools That Help Writing the Configuration](../configuration/create-configuration.md#tools-that-help-writing-the-configuration) for the options. | ||
| ``` |
There was a problem hiding this comment.
What about a page to present these tools (with subpages if needed) and having just a link to this page here?
There was a problem hiding this comment.
Yes, that is a good idea. My feeling is that the page is a bit too much information overflow now. I was thinking about maybe also move the parts about how to load and validate to separate pages and make this page purely about how to create it? But I didn't want to make to many changes to your PR in one go.
There was a problem hiding this comment.
That page is too loaded, it's better to split it. I will have a try from your version.
There was a problem hiding this comment.
I think having the tools on a separate page is also good because then that page can be more dynamic while the page about how to create the config changes less frequently. My feeling is that we have some tools now but not all of them are good, some have potential for improvement whereas other should maybe just be removed after user feedback. And then we also have the new ideas in progress with templates and a tool to automatically generate a simple config from a lattice file that should be added when they are ready for user tests.
| ## Write Configuration as a Text File | ||
|
|
||
| ## Write the Configuration File | ||
| Here an example is shown for how to create the configuration in a YAML file. The steps are similar if using JSON. The steps below build a small but complete configuration, using the names of the [test lattice](../../tutorials/functionality/01_create_accelerator). |
There was a problem hiding this comment.
I don't see why a mention of the test lattice is needed. I would remove this part
There was a problem hiding this comment.
Works for me. I just moved the existing section and thought the link was not ideal but you are right. It is better to remove it.
This branch has not been deployed
2 participants
I have updated the content of the how-to guide for the configuration.
Some parts in it was wrong (for catalogs and validation) but otherwise I mostly added links and moved some things around to improve the readability and flow.
Things I found are missing that we should add:
What to do if you don't have unique names in your lattice but family names. This is easy and I think just a sentence is needed but I'm not sure about the current option so I didn't add it.
Difference between validation of configuration and validation during object creation. This is content that I need to add at other places since it's currently completely missing from the documentation. There are also some default options that needs to be changed at some places which I have assigned issues for but done yet.
A link is needed to documentation for the test lattice. To generate documentation for that package is also an existing issue.