Skip to content

Fix typos in swap documentation templates doc #171

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

Merged
merged 1 commit into from
Apr 11, 2024
Merged

Fix typos in swap documentation templates doc #171

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions site/guide/swap-documentation-templates.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ date: last-modified

Swapping templates allows you to switch to a completely different template, upgrade to a more recent version of your current template, or make changes to both the template and template version at the same time.

When swapping templates, only the document structure is changed. Any modifications that you might have made to content is preserved inside each content block or section. If you are not sure which template or which version of a template your model documentation or validation report is using, you can also check and compare between different templates and .
When swapping templates, only the document structure is changed. Any modifications that you might have made to content is preserved inside each content block or section. If you are not sure which template or which version of a template your model documentation or validation report is using, you can also check and compare between different templates and versions of templates.

## Prerequisites

- You must hold the `Developer` role to update the template for model documentation.
- You must hold the `Validator` role to update the validation report template for their validation report.
- You must hold the `Validator` role to update the template for validation reports.

## View current templates

Expand Down Expand Up @@ -42,11 +42,11 @@ When swapping templates, only the document structure is changed. Any modificatio
- **Document Template**
- **Validation Report Template**

The window pane that opens shows the JSON for the current template along with other information, such as the name and the current version, and which models are using this template.
The window pane that opens shows the YAML for the current template along with other information, such as the name and the current version, and which models are using this template.

6. Click **Swap Template**.

The window pane now shows the JON for two templates side-by-side:
The window pane now shows the YAML for two templates side-by-side:

- On the left, your current template is shown.
- On the right, you can select a different template and version.
Expand All @@ -60,7 +60,7 @@ When swapping templates, only the document structure is changed. Any modificatio

For example: Select a previous version of the template currently in use to revert to that version.

After you select a different template or version, the JSON differences between the templates are highlighted.
After you select a different template or version, the YAML differences between the templates are highlighted.

8. Click **Prepare Swap**.

Expand Down