Skip to content

Documentation updates#570

Draft
MatthewGidcomb wants to merge 5 commits into
developmentfrom
doc-updates-202606
Draft

Documentation updates#570
MatthewGidcomb wants to merge 5 commits into
developmentfrom
doc-updates-202606

Conversation

@MatthewGidcomb

Copy link
Copy Markdown
Member

Work-in-progress documentation updates, starting with some issues Summer flagged getting started and branching out from there.

Comment thread api-server/todo.md Outdated

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@chriswininger I think the only part of this to-do list left to do is filtering by partner name, right?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Congrats on deleting this file!

Comment thread api-server/README.md Outdated

Set up the env file and add *1nfinite.pem* file to keys directory. Sample files are provided with a `.sample` suffix.
A core team member can send you the dev secrets via the Infinite Industries Slack.
Set up the env file. A sample file is provided with a `.sample` suffix.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe a note that you don't actually need to do this unless you need specific dotenv variables like AWS stuff?

Comment thread README.md Outdated

@summasmiff summasmiff left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Comments are just thoughts as someone new to the project, feel free to ignore

Comment thread api-server/README.md
Comment on lines +25 to +27
There are sane defaults for all env configuration, including local database connection (see below). The only secondary service strictly required under development is the database; everything else (auth, file storage, etc) falls back on local behavior for convenience.

If you need to override something, e.g. to test real auth, you can set the appropriate env vars or use an env file. A sample file is provided with a `.sample` suffix.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@chriswininger is this description accurate?

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