PYTHON-4095, PYTHON-4096, PYTHON-4098: Rewrite READMEs to be more approachable for first-time users #12

Jibola · 2024-01-08T17:49:36Z

Universal Changes

Changed Authorisation -> Authorization as well as updated language around distinguishing logged in and superuser
Added more cautionary information about changing passwords

`README.md` Changes

Added Requirements
Added QuickStart
Added URL Information

`docs/getting-started.md` Changes

Changed title to be Building a Generated App instead of Getting Started

NoahStapp

Much-needed clarifications, thanks Jib! Minor wording edits, I'll do a fresh install and run-through of this guide tomorrow to see if anything major sticks out.

README.md

Readme getting started refactor

…k-fastapi-mongodb into readme-refactor

NoahStapp

One final nitpick 😄

NoahStapp · 2024-01-09T23:09:41Z

README.md


-### Dashboard Login
+For those that want to dive in and play around with the generated code, here's quick start guide on how to do it. It is advised, though, once you have run through generating this app the first time, that you circle back and check out the more fleshed out [Building a Generated App](./docs/getting-started.md) section. 


"here's quick start guide" -> "here's a quick start guide"

NoahStapp · 2024-01-09T23:10:07Z

README.md

+- Flower: Admin tool of Celery Tasks -- http://localhost:5555
+- Traefik UI to see how routes are being handled by the proxy: http://localhost:8090
+
+See [Building a Generated App](./docs/getting-started.md) for images of what some of these pages will look like and to understand the configuration details better.


README.md

NoahStapp

Minor consistency edits, then all good to go!

README.md

docs/authentication-guide.md

README.md

docs/authentication-guide.md

README.md

docs/authentication-guide.md

Jibola and others added 9 commits January 4, 2024 08:03

adding in Quickstart and Requirements to main README

8595283

Updating README information to be more informative for first-time users

ba50ebb

Merge branch 'mongodb-labs:main' into readme-refactor

63152aa

moved index upwards

0d1f560

rename

4e2c44b

removed the screenshot section from the start page

1ecdb89

Refactored Getting Started to have clearer instructions

b08c4cb

adding addiitonal context

fdc94d7

added caution details

3efcfaa

Jibola requested review from a team, ShaneHarvey and NoahStapp and removed request for a team and ShaneHarvey January 8, 2024 20:22

Jibola changed the title ~~[Task]: README.md refactor for first-time users~~ [Task]: README.md rewrite for first-time users Jan 8, 2024

NoahStapp requested changes Jan 8, 2024

View reviewed changes

addressed PR changes

fae9525

Jibola requested a review from NoahStapp January 9, 2024 18:01

Jibola mentioned this pull request Jan 9, 2024

[Task]: Readme rewrite development guide #13

Merged

Jibola and others added 3 commits January 9, 2024 15:44

Merge branch 'main' into readme-refactor

3802ce3

Merge pull request #1 from Jibola/readme-getting-started-refactor

974ac09

Readme getting started refactor

Merge branch 'mongodb-labs:main' into readme-refactor

d83bda0

Jibola mentioned this pull request Jan 9, 2024

[Task]: Readme getting started refactor #14

Closed

Jibola changed the title ~~[Task]: README.md rewrite for first-time users~~ [Task]: Rewrite READMEs to be more approachable for first-time users Jan 9, 2024

Jibola added 2 commits January 9, 2024 15:54

Merge branch 'readme-refactor' of https://github.com/Jibola/full-stac…

1983cd9

…k-fastapi-mongodb into readme-refactor

Added in resolutions from PR mongodb-labs#13 and mongodb-labs#14

a2c2bb9

NoahStapp requested changes Jan 9, 2024

View reviewed changes

Jibola commented Jan 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

bb1912b

Jibola commented Jan 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

5e8421e

Jibola requested a review from NoahStapp January 10, 2024 14:05

Jibola changed the title ~~[Task]: Rewrite READMEs to be more approachable for first-time users~~ PYTHON-4095: Rewrite READMEs to be more approachable for first-time users Jan 10, 2024

Jibola changed the title ~~PYTHON-4095: Rewrite READMEs to be more approachable for first-time users~~ PYTHON-4095, PYTHON-4096, PYTHON-4098: Rewrite READMEs to be more approachable for first-time users Jan 10, 2024

Jibola added 3 commits January 10, 2024 10:40

minor word corrections to authentication and websocket guide

688808e

remove old alembic information

ad23408

add port signature to the localhost route

560b473

NoahStapp requested changes Jan 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

docs/authentication-guide.md Outdated Show resolved Hide resolved

Jibola commented Jan 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Jibola commented Jan 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Jibola commented Jan 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Jibola commented Jan 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Jibola commented Jan 10, 2024

View reviewed changes

docs/authentication-guide.md Outdated Show resolved Hide resolved

G -> g

0aae359

NoahStapp approved these changes Jan 10, 2024

View reviewed changes

Jibola commented Jan 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Jibola commented Jan 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Jibola commented Jan 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Jibola commented Jan 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

Jibola commented Jan 10, 2024

View reviewed changes

docs/authentication-guide.md Outdated Show resolved Hide resolved

A -> a

5619d6b

Jibola merged commit 31b16ba into mongodb-labs:main Jan 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PYTHON-4095, PYTHON-4096, PYTHON-4098: Rewrite READMEs to be more approachable for first-time users #12

PYTHON-4095, PYTHON-4096, PYTHON-4098: Rewrite READMEs to be more approachable for first-time users #12

Jibola commented Jan 8, 2024 •

edited

Loading

NoahStapp left a comment

NoahStapp left a comment

NoahStapp Jan 9, 2024

NoahStapp Jan 9, 2024

NoahStapp left a comment


		### Dashboard Login
		For those that want to dive in and play around with the generated code, here's quick start guide on how to do it. It is advised, though, once you have run through generating this app the first time, that you circle back and check out the more fleshed out [Building a Generated App](./docs/getting-started.md) section.

PYTHON-4095, PYTHON-4096, PYTHON-4098: Rewrite READMEs to be more approachable for first-time users #12

PYTHON-4095, PYTHON-4096, PYTHON-4098: Rewrite READMEs to be more approachable for first-time users #12

Conversation

Jibola commented Jan 8, 2024 • edited Loading

Universal Changes

README.md Changes

docs/getting-started.md Changes

NoahStapp left a comment

Choose a reason for hiding this comment

NoahStapp left a comment

Choose a reason for hiding this comment

NoahStapp Jan 9, 2024

Choose a reason for hiding this comment

NoahStapp Jan 9, 2024

Choose a reason for hiding this comment

NoahStapp left a comment

Choose a reason for hiding this comment

Jibola commented Jan 8, 2024 •

edited

Loading

`README.md` Changes

`docs/getting-started.md` Changes