Make changes to Docker Installation, including adding step by step in… #7
Conversation
| Fidesctl requires multiple components to function as it is a multi-part application. You may therefore also be interested in launching fidesctl in the Docker Compose environment, see: [Running Fidesctl in Docker](../quickstart/docker.md). | ||
| The following is an overview of the fidesctl Docker Hub release process, including release cadence and what's included. | ||
|
|
||
| **Release Cadences** |
There was a problem hiding this comment.
Interesting that "Release Cadence" is before "Installation" @brycebortree . If someone landed on these instructions with the intention of deploying the docker image, do you suppose it might be helpful to have that first?
For reference, here is where it sits in the IA:
There was a problem hiding this comment.
This is definitely the change I was the most on the fence about. With fresh eyes, I do think Installation should go first. Thanks for the screenshot as well!
| Install Docker and Docker Compose, then pull the latest container image from Docker Hub. | ||
|
|
||
| 1. Install `docker` locally (see [Docker Desktop](https://www.docker.com/products/docker-desktop) or your preferred installation). The minimum verified Docker version is `20.10.8` | ||
| 2. If your `docker` installation did not include `docker-compose`, make sure to get at least version `1.29.0`. Installation instructions can be found in the [Docker Compose documentation](https://docs.docker.com/compose/install/). |
There was a problem hiding this comment.
how would I know that my installation didn't include docker-compose? it may not be necessary to explicitly state instructions on how to check for it, but maybe link to instructions on how to confirm?
There was a problem hiding this comment.
@brycebortree Overall these are meaningful changes! Review the comments left here and reply with your response, or update the PR accordingly. Thanks!
| You're now ready to start enforcing privacy with Fidesctl! Below are suggestions for continuing your journey. | ||
|
|
||
| - See [Setting up the database](./database.md) to set up the Postgresql for fidesctl. | ||
| - See [Running Fidesctl in Docker](../quickstart/docker.md) for more information on launching fidesctl in Docker Compose. Fidesctl requires multiple components to function as it is a multi-part application. |
There was a problem hiding this comment.
"Running Fidesctl in Docker" contains the same instructions you've included here from the System Requirements section. In your opinion, does it make sense to have it in both places? (this is not a leading question! and you don't have to update the PR if you don't feel it's necessary, I want to understand your opinion on this)
There was a problem hiding this comment.
This is a great question!
In my last role, we had reusable files that would be able to be shared across page for shared instructions like this.
I think a solution like that, or simply linking to System Requirements would be best here. Having the same instructions in too places will just lead to tech debt in the future.
For now, I'll update with a link to System Requirements.
|
I decided to put the full Installation instruction in the Installation from Docker section. But it raises a similar question with the Release Cadence and Installation from before: what will the developer's path through the documentation be? I see a few more options: move Quick Start below Installation and before Tutorial, combine Quick Start and Installation for Docker, or have those instructions in Quick Start since it will come first. The last would likely be the quickest, since I see the other two as larger refactors. What are your thoughts here? |
Steps to Confirm
make docs-serveand checked changes locallyPre-Merge Checklist
Description Of Changes
I made some updates to the Docker Installation instructions. These include:
I went back and forth on whether to put "Installation" or "Docker Hub Releases" first. I think most developers would come to the page for those directions first, but the Docker Hub Releases section has important information as well.
I added "Implementation is not finalized in mid-release versions." based on past experience developing, to offer developers a bit of guidance on whether the "dirty versions" are safe to integrate against. But it is an educated guess.