Skip to content

Updated the section template editor #64

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

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

srz11d
Copy link
Contributor

@srz11d srz11d commented Oct 23, 2024

The section has been updated and new subsections have been added, including: Dictionaries, Ontologies and Validation

@srz11d srz11d requested review from a team as code owners October 23, 2024 14:52
@srz11d srz11d requested a review from a team October 23, 2024 14:52

![image](doc-odm-user-guide/images/quickstart_user_dashboard.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

could you please remove the file quickstart_user_dashboard.png if we don't use it anymore


![image](doc-odm-user-guide/images/shortcut_1_37.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

could you please remove the file shortcut_1_37.png if we don't use it anymore


![image](doc-odm-user-guide/images/templates-list.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

could you please remove the file templates-list.png if we don't use it anymore


![image](doc-odm-user-guide/images/change-template-me.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

could you please remove the file change-template-me.png if we don't use it anymore


![image](doc-odm-user-guide/images/Template_dropdown.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

could you please remove the file Template_dropdown.png if we don't use it anymore


Users with appropriate permissions can create new templates. Refer to the section User Setup for more on user roles and permissions. Templates can be created via:

* **Python Script**: Import a new template using JSON files. Follow the instructions in the [Create a new template](https://github.com/genestack/user-docs/blob/develop/docs/tools/odm-sdk/terminal/templates/create-or-update-template.md) section on the ODM GitHub page.
Copy link
Contributor

Choose a reason for hiding this comment

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

we don't have to provide any link to the github, please, use current user guide pages instead: <server_address>/user-docs/tools/odm-sdk/terminal/templates/create-or-update-template/, also please update the screenshot


* **Python Script**: Import a new template using JSON files. Follow the instructions in the [Create a new template](https://github.com/genestack/user-docs/blob/develop/docs/tools/odm-sdk/terminal/templates/create-or-update-template.md) section on the ODM GitHub page.

![10Create.png](doc-odm-user-guide/images/10Create.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

we don't have to provide any link to the github, please, use current user guide pages instead: <server_address>/user-docs/tools/odm-sdk/terminal/templates/create-or-update-template/, also please update the screenshot

* **Python Script**: Import a new template using JSON files. Follow the instructions in the [Create a new template](https://github.com/genestack/user-docs/blob/develop/docs/tools/odm-sdk/terminal/templates/create-or-update-template.md) section on the ODM GitHub page.

![10Create.png](doc-odm-user-guide/images/10Create.png)
<figcaption>Import a new template using JSON files. Follow the instructions in the <a href="https://github.com/genestack/user-docs/blob/develop/docs/tools/odm-sdk/terminal/templates/create-or-update-template.md">Create a new template</a> section</figcaption>
Copy link
Contributor

Choose a reason for hiding this comment

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

we don't have to provide any link to the github, please, use current user guide pages instead: <server_address>/user-docs/tools/odm-sdk/terminal/templates/create-or-update-template/, also please update the screenshot


![image](doc-odm-user-guide/images/template_grouping.png)
!!! note "Important"
Uploading dictionaries is an advanced feature and it is done via a Python script. Follow the instructions on the [GitHub pages](https://github.com/genestack/user-docs/blob/develop/docs/tools/odm-sdk/terminal/dictionaries-and-ontologies/creating-new-dictionary.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

we shouldn't provide any link to this outdated repo, please, use pages from the current user guide: <server_address>/user-docs/tools/odm-sdk/terminal/dictionaries-and-ontologies/creating-new-dictionary/


You can export a JSON file which contains the template information by clicking the template name and selecting export from the drop down menu:
* **Changing Templates**: The specific template applied to a dataset can be changed if necessary. To do this, users can click on the **Apply another.**.. option from the study title drop-down menu. This allows for dynamic adjustment of validation rules to fit different data curation needs.
Copy link
Contributor

Choose a reason for hiding this comment

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

why do we need to mention template changing again? this instruction has been mentioned above (Change Template)

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

Successfully merging this pull request may close these issues.

2 participants