-
Notifications
You must be signed in to change notification settings - Fork 79
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
docs: page for docker #467
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@anant-writer @raaymax Let's rethink this
|
||
::: warning Platform considerations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey why was this removed, has it stopped being a problem?
docs/docs/deploy-with-docker.md
Outdated
``` | ||
This will create a virtual environment (if it doesn't already exist) and install all dependencies listed in `pyproject.toml`. | ||
|
||
### What is Docker and Why Use It? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raaymax @anant-writer I don't think we need this section. If we're targeting people who have no idea what Docker is, we'll need to be much more explicit about everything. We're transitioning from some high-level features to "Creating a Dockerfile" without discussing what an image is, what a Dockerfile is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, this whole thing is inside a section called "Creating a Docker image", we really need to rethink the subtitle if we're going so general.
docs/docs/deploy-with-docker.md
Outdated
- Create a `pyproject.toml` using `poetry init` and install `streamsync` using `poetry add streamsync` | ||
- Create a `pyproject.toml` using `poetry init` and install `writer` using `poetry add writer` | ||
|
||
### What is Poetry and Its Purpose? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raaymax @anant-writer I'd phrase more like "Poetry is [...], and Writer Framework uses it to [...]." It needs to be clear that it isn't an option.
docs/docs/deploy-with-docker.md
Outdated
|
||
## Creating a Docker image | ||
|
||
### Setting up | ||
|
||
- Make sure you have Docker installed. | ||
- Open a terminal and navigate to your app's folder. | ||
- Create a `pyproject.toml` using `poetry init` and install `streamsync` using `poetry add streamsync` | ||
- Create a `pyproject.toml` using `poetry init` and install `writer` using `poetry add writer` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pyproject.toml
is included in the created app. Shouldn't we use that?
No description provided.