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: add user documentation on how to use Zebra with docker #5504

Merged
merged 10 commits into from Nov 1, 2022

Conversation

gustavovalverde
Copy link
Member

@gustavovalverde gustavovalverde commented Oct 29, 2022

Motivation:

We don't have a user documentation on how to use/deploy Zebra using our the Dockerfile available in our repository or were the images are being hosted

Solution:

Add user documentation explaining how to pull the image from the Docker Hub or how to build it locally. With extra information on which images we're hosting and where we're hosting it

Motivation

Review

Anyone can review this

Reviewer Checklist

  • Will the PR name make sense to users?
    • Does it need extra CHANGELOG info? (new features, breaking changes, large changes)
  • Are the PR labels correct?
  • Does the code do what the ticket and PR says?
  • How do you know it works? Does it have tests?

Follow Up Work

We should have easier deployment instructions for non-Docker users. Using something as https://github.com/GoogleCloudPlatform/cloud-run-button#cloud-run-button or https://github.com/GoogleCloudPlatform/click-to-deploy

Motivation:

We don't have a user documentation on how to use/deploy Zebra using our
the Dockerfile available in our repository or were the images are being
hosted

Solution:

Add user documentation explaining how to pull the image from the Docker
Hub or how to build it locally. With extra information on which images
we're hosting and where we're hosting it
@gustavovalverde gustavovalverde added A-docs Area: Documentation A-devops Area: Pipelines, CI/CD and Dockerfiles C-enhancement Category: This is an improvement P-Medium ⚡ I-usability Zebra is hard to understand or use labels Oct 29, 2022
@gustavovalverde gustavovalverde self-assigned this Oct 29, 2022
@gustavovalverde gustavovalverde requested a review from a team as a code owner October 29, 2022 22:35
@gustavovalverde gustavovalverde requested review from arya2 and removed request for a team October 29, 2022 22:35
@github-actions github-actions bot added the C-feature Category: New features label Oct 29, 2022
Copy link
Contributor

@teor2345 teor2345 left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for this!

I think we need to add the new document to the release checklist, and remove some duplicate Docker info in the README.

README.md Outdated Show resolved Hide resolved
book/src/user/docker.md Outdated Show resolved Hide resolved
Copy link
Contributor

@arya2 arya2 left a comment

Choose a reason for hiding this comment

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

This looks great!

Let's also add a link to this page in the sidebar.

book/src/user/docker.md Outdated Show resolved Hide resolved
@github-actions github-actions bot added the C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG label Oct 31, 2022
teor2345
teor2345 previously approved these changes Oct 31, 2022
Copy link
Contributor

@teor2345 teor2345 left a comment

Choose a reason for hiding this comment

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

Looks great!

I fixed the merge conflict, happy to merge with or without my suggestion.

README.md Outdated Show resolved Hide resolved
Co-authored-by: teor <teor@riseup.net>
@teor2345
Copy link
Contributor

teor2345 commented Nov 1, 2022

@Mergifyio update

teor2345
teor2345 previously approved these changes Nov 1, 2022
@mergify
Copy link
Contributor

mergify bot commented Nov 1, 2022

update

✅ Branch has been successfully updated

book/src/user/docker.md Outdated Show resolved Hide resolved
book/src/user/docker.md Outdated Show resolved Hide resolved
Copy link
Contributor

@teor2345 teor2345 left a comment

Choose a reason for hiding this comment

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

I just updated the new tags to rc.1, because PR #5513 is open, but it will merge after this PR.

@teor2345
Copy link
Contributor

teor2345 commented Nov 1, 2022

@Mergifyio refresh

@mergify
Copy link
Contributor

mergify bot commented Nov 1, 2022

refresh

✅ Pull request refreshed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-devops Area: Pipelines, CI/CD and Dockerfiles A-docs Area: Documentation C-enhancement Category: This is an improvement C-feature Category: New features C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG I-usability Zebra is hard to understand or use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants