Skip to content

Add a README for the API app#686

Merged
jchristgit merged 2 commits into
mainfrom
readme-for-api-app
Mar 6, 2022
Merged

Add a README for the API app#686
jchristgit merged 2 commits into
mainfrom
readme-for-api-app

Conversation

@jchristgit
Copy link
Copy Markdown
Contributor

No description provided.

@jchristgit jchristgit added the area: docs Adds or updates documentation label Mar 3, 2022
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 3, 2022

✔️ Deploy Preview for pydis-static ready!

🔨 Explore the source changes: 073e09a

🔍 Inspect the deploy log: https://app.netlify.com/sites/pydis-static/deploys/62248acd83c1e800089269f9

😎 Browse the preview: https://deploy-preview-686--pydis-static.netlify.app

@coveralls
Copy link
Copy Markdown

coveralls commented Mar 3, 2022

Coverage Status

Coverage remained the same at 100.0% when pulling 073e09a on readme-for-api-app into e5b2750 on main.

Copy link
Copy Markdown
Contributor

@janine9vn janine9vn left a comment

Choose a reason for hiding this comment

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

Fantastic and helps explain how our api folder is setup with wonderful resources as well.

I have a small comment/note, but otherwise this makes it much more approachable with clear points/resources that people can run with and learn more about if they're feeling a bit lost.

Comment thread pydis_site/apps/api/README.md Outdated
Copy link
Copy Markdown
Contributor

@MarkKoz MarkKoz left a comment

Choose a reason for hiding this comment

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

Maybe the migrations and models could use some more explanation (i.e. what those terms actually mean), but it could be covered elsewhere in a more general area I suppose.

@jchristgit
Copy link
Copy Markdown
Contributor Author

Maybe the migrations and models could use some more explanation (i.e. what those terms actually mean), but it could be covered elsewhere in a more general area I suppose.

For what it's worth, I don't think we should need to explain what these mean. We require basic Django knowledge, and if you've worked through the tutorial, you know what these mean. I don't want to duplicate Django documentation here either.

@jchristgit jchristgit merged commit d1c4328 into main Mar 6, 2022
@jchristgit jchristgit deleted the readme-for-api-app branch March 6, 2022 10:23
@jchristgit
Copy link
Copy Markdown
Contributor Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Adds or updates documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants