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-2218] Update the README #1510

Merged
merged 32 commits into from
Oct 17, 2024
Merged
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
2840c66
initial edits
jaymedina Sep 24, 2024
693e473
Restructure: Moving things under contribution guidelines
jaymedina Sep 24, 2024
95eef66
Update README.md
jaymedina Sep 25, 2024
2f7e97d
Small restructure for devs and usage cases
jaymedina Oct 1, 2024
2f7327c
Update instructions for making .synapseConfig file
jaymedina Oct 1, 2024
4b155a1
Update Google credentials section
jaymedina Oct 1, 2024
8624b47
Remove step 6 from contributor installation
jaymedina Oct 1, 2024
2a22f54
Remove tests/ hyperlink
jaymedina Oct 1, 2024
8e8cd41
Fix link to CLI docs
jaymedina Oct 1, 2024
8a49820
Point users to service desk
jaymedina Oct 1, 2024
5cd91dd
Update code style section with how to run black
jaymedina Oct 1, 2024
3ee58ad
mention pre-commit in code style isntead
jaymedina Oct 1, 2024
023bb0a
Revisit Set up configuration files
jaymedina Oct 1, 2024
90930cd
.synapseCache
jaymedina Oct 2, 2024
b1cb1de
.synapseConfig location
jaymedina Oct 2, 2024
5751505
Update README.md
jaymedina Oct 2, 2024
d142839
Update README.md
jaymedina Oct 2, 2024
95b68ce
second pass through developer instructions
jaymedina Oct 2, 2024
5c9ecfe
Update README.md
jaymedina Oct 2, 2024
f2e7661
update Docker Usage section
jaymedina Oct 2, 2024
c4f9fcc
Update contribution guideline
jaymedina Oct 2, 2024
2c8c72a
tldr
jaymedina Oct 2, 2024
ce06422
address comments from FDS-1172
jaymedina Oct 2, 2024
6c4193c
Update README.md
jaymedina Oct 2, 2024
e12d7eb
Consolidate confluence docs
jaymedina Oct 4, 2024
eec2c88
Update table of contents
jaymedina Oct 4, 2024
18e1549
Update README.md
jaymedina Oct 15, 2024
c3d4552
Consolidated CONTRIBUTION.md and contributing guidelines in the README
jaymedina Oct 16, 2024
df85655
Update README.md
jaymedina Oct 16, 2024
48fbd2c
Fix broken links
jaymedina Oct 16, 2024
46f0998
Gianna comments
jaymedina Oct 16, 2024
d0e9ee9
Update table of contents
jaymedina Oct 16, 2024
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,7 @@ manifest:

> [!IMPORTANT]
> Be sure to update your `config.yml` with the location of your `.synapseConfig` created in the step above, to avoid authentication errors. Paths can be specified relative to the `config.yml` file or as absolute paths.
> If you are interacting with `schematic` with `python` directly and not through the CLI, the `.synapseConfig` needs to be in your current working directory to avoid authentication errors.

> [!NOTE]
> `config.yml` is ignored by git.
Expand Down
Loading