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.

Sign up for GitHub

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

Jump to bottom

[DOCU-1924] New "Manage decK with Docker" page #4124

Merged
merged 10 commits into from
Nov 15, 2022
Merged

[DOCU-1924] New "Manage decK with Docker" page #4124

merged 10 commits into from
Nov 15, 2022

Conversation

cloudjumpercat
Copy link
Contributor

@cloudjumpercat cloudjumpercat commented Jul 14, 2022 •
edited
Loading

Summary

Created a new page that explains how to use the Docker image to manage decK.

Questions for reviewers:

  • Do the titles/headers make sense?
  • Did I do all the necessary steps when adding a new page (I think it just had to be added to the nav page)?
  • Where in "Guides" should this live?

Reason

DOCU-1924

Testing

https://deploy-preview-4124--kongdocs.netlify.app/deck/latest/guides/manage-with-docker/

@cloudjumpercat cloudjumpercat added review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? review:copyedit Request for writer review. labels Jul 14, 2022
@cloudjumpercat cloudjumpercat requested a review from a team as a code owner July 14, 2022 18:57
@netlify
Copy link

netlify bot commented Jul 14, 2022 •
edited
Loading

✅ Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit 6522af3
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/637407e37edda400097d2152
😎 Deploy Preview https://deploy-preview-4124--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Guaris
Guaris previously requested changes Jul 14, 2022
View reviewed changes
@Guaris
Copy link
Contributor

Guaris commented Jul 14, 2022

Do the titles/headers make sense?
Did I do all the necessary steps when adding a new page (I think it just had to be added to the nav page)?
Where in "Guides" should this live?

  1. The titles do make sense. However, the rest of the docs in this section use the formula "Using decK with X". I think managing is a more descriptive word, do you think being consistent in those titles is important?
  2. Yes.
  3. I would move this to after "Using decK with Konnect"

@mheap mheap requested a review from a team August 15, 2022 12:44
@Guaris Guaris assigned Guaris and unassigned Guaris Aug 22, 2022
cloudjumpercat and others added 3 commits November 10, 2022 11:12
@cloudjumpercat
Add Docker image page
5d9af51
@cloudjumpercat
Add new page
12d148c
@cloudjumpercat @Guaris
Apply suggestions from code review
32402fd 
Co-authored-by: Angel <Guaris@users.noreply.github.com>
@cloudjumpercat
Rename file, move to new nav file, minor copyedits
a525c08 
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
@cloudjumpercat
Move location in nav
580d66e 
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
@cloudjumpercat
Fix broken link
1b4002b 
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
@cloudjumpercat
Make link to doc version specific
783bbb6 
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
@cloudjumpercat
Apply feedback, fix blank lines in nav file
d85efc5 
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
lena-larionova
lena-larionova reviewed Nov 15, 2022
View reviewed changes
Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

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

Can you please backport this as far as the single-sourcing goes? The kong/deck image has been available since long before we started writing docs about decK: https://hub.docker.com/r/kong/deck/tags

@cloudjumpercat
Backport doc to prior releases
33821b7 
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
lena-larionova
lena-larionova approved these changes Nov 15, 2022
View reviewed changes
Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

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

One minor edit to remove the topic from the pre-1.17 nav, otherwise LGTM

@cloudjumpercat @lena-larionova
Remove from pre-1.7 nav
6522af3 
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
@cloudjumpercat cloudjumpercat dismissed Guaris’s stale review November 15, 2022 21:43

Changes were addressed.

@cloudjumpercat cloudjumpercat merged commit b217186 into main Nov 15, 2022
@cloudjumpercat cloudjumpercat deleted the DOCU-1924 branch November 15, 2022 21:50
Guaris added a commit that referenced this pull request Nov 17, 2022
@Guaris @yalhyane
@renovate @mheap @jschmid1 @czeslavo @cloudjumpercat @lena-larionova @tomaszwylezek @Mierenga @andrewwylde
Merge branch 'main' into konnect (#4792)
53ca272 
* Fix typo in `config.add.querystring` description (#4765)

* chore(deps): update dependency jest to v29.3.1

* fix(deps): update dependency @segment/analytics-next to v1.46.0

* chore: uses REPO argument in installer.sh script (#4770)

Changes the `REPO_PREFIX` argument to `REPO` following changes to the kuma.io/installer.sh changes made in kumahq/kuma-website#1149.

Signed-off-by: Philipp Rudloff <philipp.rudloff@konghq.com>

Signed-off-by: Philipp Rudloff <philipp.rudloff@konghq.com>

* Fix broken link checker (#4774)

* docs(readme): add submodule update instructions

jekyll expects files in src/.repos/kuma/* which are coming from a submodule.

* kic: add translation failures troubleshooting section (#4779)

* kic: add translation failures troubleshooting

* Update troubleshooting.md

* Fix Vale errors, copyedit

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add uninstall instructions to Ubuntu (#4781)

* uninstall instructions

* spelling

* formatting

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* [DOCU-1924] New "Manage decK with Docker" page (#4124)

* Add Docker image page

* Add new page

* Apply suggestions from code review

Co-authored-by: Angel <Guaris@users.noreply.github.com>

* Rename file, move to new nav file, minor copyedits

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Move location in nav

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix broken link

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Make link to doc version specific

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply feedback, fix blank lines in nav file

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Backport doc to prior releases

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Remove from pre-1.7 nav

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Angel <Guaris@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Plugin template: Update and add sample versions file (#4783)

* add sample versions file and update plugin template [skip ci]

* uncomment version to prevent build from failing

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* [DOCU-2517] App Reg Multiple RGs and DCR - GA release (#4748)

* changelog

* feat(dcr): how to request with DCR [tdx-2587] (#4716)

* feat(dcr): how to request with DCR [tdx-2587]

Signed-off-by: Tomasz Wylężek <tomwylezek@gmail.com>

* feat(dcr): change wording [tdx-2587]

Signed-off-by: Tomasz Wylężek <tomwylezek@gmail.com>

* feat(dcr): change wording [tdx-2587]

Signed-off-by: Tomasz Wylężek <tomwylezek@gmail.com>

* feat(dcr): change wording [tdx-2587]

Signed-off-by: Tomasz Wylężek <tomwylezek@gmail.com>

Signed-off-by: Tomasz Wylężek <tomwylezek@gmail.com>

* [TDX-2195] Dev portal app reg with multi-runtime group support (#4473)

* feat(runtime-groups): remove section in runtime-groups about dev portal app reg

This information is no longer necessary with the availablity of app registration in any runtime group.

* feat(enable-app-reg): update bullet about runtime group compatibility

* feat(enable-app-reg): add sub-bullets about Gateway versions

* feat(app-reg): add runtime group compatibility info

* refactor(app-reg): remove redundant info

* fix(app-reg): replace Kong Gateway with variable

* feat(app-reg): add clarification about default runtime group

* feat(app-reg): link back to default runtime group info

* feat(app-reg): add section about runtime group differences

* refactor(app-reg): update info about OIDC credential claims

* chore(app-reg): adjust indentation of Note to ensure it renders properly

* fix(app-reg): add article and fix spacing

* feat(app-reg): add alpha badges

* Revert "feat(app-reg): add alpha badges"

This reverts commit 43b0711.

* feat(app-reg): add section with badge about alpha stage

* fix(app-reg): move badge out of heading

* refactor(app-reg): update intro to account for multi-runtime groups

* fix(app-reg): move badge below heading

* fix(app-reg): remove unnecessary link and overused word

* refactor(app-reg): make mode names consistent with other usages

* Update app/konnect/dev-portal/applications/enable-app-reg.md

Co-authored-by: Andrew Wylde <drewkakes@gmail.com>

Co-authored-by: Andrew Wylde <drewkakes@gmail.com>

* Apply suggestions from code review

Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Update app/konnect/updates.md

Signed-off-by: Tomasz Wylężek <tomwylezek@gmail.com>
Co-authored-by: Tomasz Wylężek <tomwylezek@gmail.com>
Co-authored-by: Mike Swierenga <mike.swierenga@gmail.com>
Co-authored-by: Andrew Wylde <drewkakes@gmail.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add a/b test support for the top CTA

Signed-off-by: Philipp Rudloff <philipp.rudloff@konghq.com>
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Signed-off-by: Tomasz Wylężek <tomwylezek@gmail.com>
Co-authored-by: yalhyane <y.alhyane@gmail.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Philipp Rudloff <philipp.rudloff@konghq.com>
Co-authored-by: Michael Heap <m@michaelheap.com>
Co-authored-by: Joshua Schmid <joshua.schmid@konghq.com>
Co-authored-by: Grzegorz Burzyński <czeslavo@gmail.com>
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: Tomasz Wylężek <tomwylezek@gmail.com>
Co-authored-by: Mike Swierenga <mike.swierenga@gmail.com>
Co-authored-by: Andrew Wylde <drewkakes@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mheap mheap mheap left review comments

@lena-larionova lena-larionova lena-larionova approved these changes

@Guaris Guaris Guaris left review comments

@yankun-li-kong yankun-li-kong Awaiting requested review from yankun-li-kong

Assignees
No one assigned
Labels
review:copyedit Request for writer review. review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly?
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@cloudjumpercat @Guaris @mheap @lena-larionova