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

Linux Installation how-tos #399

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Linux Installation how-tos #399

wants to merge 5 commits into from

Conversation

Guaris
Copy link
Contributor

@Guaris Guaris commented Feb 5, 2025

Update 2/19

This ticket does a few things:

  • Creates separate stand-alone installation pages for all distributions (including FIPS). From this thread
  • Pulls the datastore doc into an include and includes it at the bottom of every page. From this thread
  • Does not create an installation reference page. This requires platform updates and shouldn't block the content. Ticket for that here.
  • Adds installation prereqs that can be used for future docs.
  • The information in app/_how-tos/nonroot.md should exist in the future installation landing page.

Description

Fixes #387
Fixes #395 (rather invalidates it).

There is a ticket to create generated links out of the URLs in the platform.

Preview Links

Checklist

  • Every page is page one.
  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Updated sources.yaml. For more info, review track docs changes
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.

@Guaris Guaris requested a review from a team as a code owner February 5, 2025 20:13
Copy link

netlify bot commented Feb 5, 2025

Deploy Preview for kongdeveloper failed.

Name Link
🔨 Latest commit a8dbdf3
🔍 Latest deploy log https://app.netlify.com/sites/kongdeveloper/deploys/67b637c16fb1750009f03e08

@Guaris Guaris requested a review from lena-larionova February 5, 2025 20:17
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this page exist, or should the info just be on the install doc?

{% navtabs %}
{% navtab "Manual Installation" %}
1. Download {{site.base_gateway}}:
```sh
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove the indents in these codeblocks (see my slack message) so that we don't get extra spaces at the start of the codeblock.

{% endnavtabs %}

3. Enable FIPS

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change


You can check the permissions and ownership of the {{site.base_gateway}} in Linux like this:

`ls -l /usr/local/kong`
Copy link
Contributor

Choose a reason for hiding this comment

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

If your worry is people copy/pasting, they can copy & paste anything. So using just one backtick doesn't solve it. We should still use codeblocks here, and use this class with them {:.no-copy-code}. It'll disable the copy button.

@Guaris
Copy link
Contributor Author

Guaris commented Feb 6, 2025

@Guaris Guaris requested a review from fabianrbz February 6, 2025 21:03
@lena-larionova lena-larionova marked this pull request as draft February 7, 2025 16:28
@lena-larionova lena-larionova added the do not merge Issues/ PRs whose changes should not be merged at this time label Feb 7, 2025
@Guaris Guaris mentioned this pull request Feb 19, 2025
7 tasks
@Guaris Guaris changed the title Linux Installation reference page Linux Installation how-tos Feb 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do not merge Issues/ PRs whose changes should not be merged at this time
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Install Kong Gateway Linux config guides Configure KGW datastore
2 participants