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

✏️ Spacing changes for docs project #289

Merged
merged 1 commit into from
Aug 6, 2024
Merged

✏️ Spacing changes for docs project #289

merged 1 commit into from
Aug 6, 2024

Conversation

williln
Copy link
Contributor

@williln williln commented Aug 6, 2024

The editorconfig is already set to 4 spaces, so this just brings the README in line with that. This benefits mkdocs over in https://github.com/westerveltco/central-docs/

⚠️ Looking at the diff, I think the README might be out of sync so I am going to come back to this one.

Comment on lines -48 to +63
```sh
# to start the containers detached in the background
just docker start
# to start the containers in the foreground with the logs continuously streaming in stdout
just docker up
```
To start the containers in the background:

After starting, you should be able to access the development server at [http://localhost:8000](http://localhost:8000).
```sh
just docker start
```

By default, the development server will run on port 8000. If you need to change the port, you can do so by setting the `DJANGO_PORT` environment variable in the `.env` file and then restarting the development server.
To start the containers in the foreground with the logs continuously streaming in stdout

```sh
just docker up
```

After starting, you should be able to access the development server at [http://localhost:8000](http://localhost:8000).

By default, the development server will run on port 8000. If you need to change the port, you can do so by setting the `DJANGO_PORT` environment variable in the `.env` file and then restarting the development server.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is all the same, it's just split up a little bit for formatting purposes. (I was having trouble getting the list, code, and paragraph to render appropriately in mkdocs, and splitting it up seemed to help.)

@williln williln marked this pull request as ready for review August 6, 2024 17:40
@williln williln requested a review from a team as a code owner August 6, 2024 17:40
@williln williln merged commit e13d625 into main Aug 6, 2024
6 checks passed
@williln williln deleted the docs-edits branch August 6, 2024 20:55
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