Help improve this page
To contribute to this user guide, choose the Edit this page on GitHub link that is located in the right pane of every page.
If you want to propose change to multiple pages, or create a new docs page, use the GitHub.dev web editor. This web editor is based on the popular Visual Studio Code text editor.
Prerequisites
-
Logged in to GitHub
-
Familiarity with Visual Studio Code editor
-
Familiarity with Git
Procedure
Note
The EKS Docs team has created a workspace file that includes suggested configurations for the editor, such as text wrapping and AsciiDoc syntax highlighting. We suggest you load this workspace file.
-
Open the workspace
on GitHub.dev. -
(First time setup only) You may be prompted to create a fork of the repo in your own GitHub account. Accept this prompt. For more information, see About forks
in the GitHub docs. -
(First time setup only) Accept the prompt in the bottom right to install the AsciiDoc extension.
-
Navigate to the docs content at
latest/ug.-
Docs files are organized by their top level section. For example, pages in the "Security" chapter have source files under the "security/" directory.
-
-
To view a preview of a docs page, use the Open preview to the Side button in the top right. The icon includes a small magnifying glass.
-
Use the Source Control tab in the left to commit your changes. For more information, see the Visual Studio Code docs:
After you create a pull request, it will be reviewed by the docs team.
