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

docs: page for docker #467

Closed
wants to merge 2 commits into from
Closed

docs: page for docker #467

wants to merge 2 commits into from

Conversation

raaymax
Copy link
Collaborator

@raaymax raaymax commented Jun 17, 2024

No description provided.

Copy link
Collaborator

@ramedina86 ramedina86 left a 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
Copy link
Collaborator

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?

```
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?
Copy link
Collaborator

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.

Copy link
Collaborator

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.

- 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?
Copy link
Collaborator

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.


## 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`
Copy link
Collaborator

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?

@raaymax raaymax closed this Jun 20, 2024
@raaymax raaymax deleted the docs_for_docker branch June 20, 2024 11:24
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