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

[FDS-2466] Update references to schema location in config.yml #1522

Merged
merged 3 commits into from
Oct 30, 2024

Conversation

jaymedina
Copy link
Contributor

@jaymedina jaymedina commented Oct 21, 2024

problem

A user reported lack of clarity in the expected location of the model schema in the Confluence documentation (see ticket for more context)

solution

The README documentation in the schematic repository is now the single source of truth, so I went ahead and moved sections around to improve the flow of the doc.

Changes:

  • Moved the Set up configuration files section below Google credentials section. Now, schematic users will set up their Google credentials and download their relevant schema file before setting up the config.yaml, at which point the instructions in section 6 are clear for where the schema file should live.
  • Changed config.yaml update example so that users can see how they would modify the path to their model schema in the config.yaml.
  • Moved the IMPORTANT banner in section 4. Get your data model as a JSON-LD schema file to section 6 because it flowed better with the new example from above.

testing

N/A

Copy link

@jaymedina jaymedina marked this pull request as ready for review October 22, 2024 14:48
@jaymedina
Copy link
Contributor Author

I've cancelled the test (3.10) check since these changes only affect the README.

Copy link
Member

@thomasyu888 thomasyu888 left a comment

Choose a reason for hiding this comment

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

🔥 LGTM!

@andrewelamb andrewelamb merged commit c69ec88 into develop Oct 30, 2024
4 of 6 checks passed
@andrewelamb andrewelamb deleted the develop-fds-2466-update-config.yml branch October 30, 2024 15:18
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.

3 participants