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

Update Docker Quickstart #2482

Merged
merged 15 commits into from
Aug 17, 2021
Merged

Update Docker Quickstart #2482

merged 15 commits into from
Aug 17, 2021

Conversation

alexfornuto
Copy link
Contributor

@alexfornuto alexfornuto commented Aug 16, 2021

Summary

This update simplifies the quickstart process by assuming a local test environment without a TLS solution or a FQDN

Additionally, this PR expands the Docs site with the markdown-it-includes plugin, allowing us to single-source content we want to include in multiple pages.

Checklist

  • reference any related issues
  • updated docs
  • updated unit tests
  • updated UPGRADING.md
  • add appropriate tag (improvement / bug / etc)
  • ready for review

@alexfornuto alexfornuto added docs Docs update required backport 0-15-0 labels Aug 16, 2021
@alexfornuto alexfornuto requested review from a team as code owners August 16, 2021 21:25
@codeclimate
Copy link

codeclimate bot commented Aug 16, 2021

Code Climate has analyzed commit 203280d and detected 0 issues on this pull request.

View more on Code Climate.

@coveralls
Copy link

coveralls commented Aug 16, 2021

Coverage Status

Coverage increased (+0.1%) to 64.387% when pulling 203280d on docs/quickstart-update into 6a69d39 on master.

docs/docs/install/readme.md Outdated Show resolved Hide resolved
docs/partials/install-mkcert.md Outdated Show resolved Hide resolved
examples/config/config.docker.yaml Outdated Show resolved Hide resolved
examples/config/config.docker.yaml Outdated Show resolved Hide resolved
examples/config/config.docker.yaml Outdated Show resolved Hide resolved
examples/docker/basic.docker-compose.yml Outdated Show resolved Hide resolved
examples/docker/basic.docker-compose.yml Outdated Show resolved Hide resolved
examples/config/config.docker.yaml Outdated Show resolved Hide resolved
alexfornuto and others added 15 commits August 17, 2021 10:15
This update simplifies the quickstart process by assuming a local test environment without a TLS solution or a FQDN
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
@alexfornuto alexfornuto merged commit 65760a9 into master Aug 17, 2021
@alexfornuto alexfornuto deleted the docs/quickstart-update branch August 17, 2021 15:22
@backport-actions-token
Copy link

The backport to 0-15-0 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-0-15-0 0-15-0
# Navigate to the new working tree
cd .worktrees/backport-0-15-0
# Create a new branch
git switch --create backport-2482-to-0-15-0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 65760a9f707dec5986297d476ad56101ea78ed99
# Push it to GitHub
git push --set-upstream origin backport-2482-to-0-15-0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-0-15-0

Then, create a pull request where the base branch is 0-15-0 and the compare/head branch is backport-2482-to-0-15-0.

1 similar comment
@backport-actions-token
Copy link

The backport to 0-15-0 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-0-15-0 0-15-0
# Navigate to the new working tree
cd .worktrees/backport-0-15-0
# Create a new branch
git switch --create backport-2482-to-0-15-0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 65760a9f707dec5986297d476ad56101ea78ed99
# Push it to GitHub
git push --set-upstream origin backport-2482-to-0-15-0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-0-15-0

Then, create a pull request where the base branch is 0-15-0 and the compare/head branch is backport-2482-to-0-15-0.

alexfornuto pushed a commit that referenced this pull request Aug 17, 2021
* Implement partial files

* fix markdown link

* Update Quickstart Doc

This update simplifies the quickstart process by assuming a local test environment without a TLS solution or a FQDN

* add TLS warning

* point to local verify container

* rm empty file

* reference Certificate topic page instructions

* update mkcert instructions

* Update docs/docs/install/readme.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update docs/partials/install-mkcert.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* review edits

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
alexfornuto pushed a commit that referenced this pull request Aug 17, 2021
* Implement partial files

* fix markdown link

* Update Quickstart Doc

This update simplifies the quickstart process by assuming a local test environment without a TLS solution or a FQDN

* add TLS warning

* point to local verify container

* rm empty file

* reference Certificate topic page instructions

* update mkcert instructions

* Update docs/docs/install/readme.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update docs/partials/install-mkcert.md

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* Update examples/config/config.docker.yaml

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

* review edits

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>

Co-authored-by: bobby <1544881+desimone@users.noreply.github.com>
@alexfornuto alexfornuto mentioned this pull request Aug 17, 2021
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 0-15-0 docs Docs update required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants