You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: latest/bpg/contribute.adoc
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,15 +56,31 @@ Learn how to https://docs.github.com/en/pull-requests/collaborating-with-pull-re
56
56
57
57
Learn how to https://cli.github.com/manual/gh_pr_create[create a pull request] by using the GitHub cli.
58
58
59
-
// == Edit the guide online
59
+
== Use the github.dev web-based editor
60
60
61
-
// Editing the guide online is a great way to make a small change to a single page.
61
+
The `github.dev` web-based editor is based on VS Code. This is a great way to edit multiple files and preview content without any setup.
62
+
63
+
It has support for the AsciiDoc extension. You can do git operations by using the GUI. The web-based editor does not have a shell or terminal for running commands.
64
+
65
+
You must have a GitHub account. You will be prompted to login if required.
66
+
67
+
https://github.dev/aws/aws-eks-best-practices/blob/master/bpg-docs.code-workspace?workspace=true[🚀 Launch the GitHub web-based editor.]
68
+
69
+
== Edit a single page
70
+
71
+
You can rapidly update individual pages by using GitHub. Each page contains an "📝 Edit this page on GitHub" link at the bottom.
72
+
73
+
. Navigate to the page in this guide you want to edit
74
+
. Click the "Edit this page on GitHub" link at the bottom
75
+
. Click the edit pencil icon on the top right of the GitHub file viewer, or press `e`
76
+
. Edit the file
77
+
. Submit your changes using the "Commit changes..." button. This button creates a GitHub pull request. The guide maintainers will review this pull request. A reviewer will approve the pull request, or request changes.
62
78
63
79
== View and set the ID for a page
64
80
65
81
This page explains how to view and set page ID.
66
82
67
-
The page ID is a unique string that identifies each page on the documentation site. You can view the page ID in the address bar of your browser when you're on a specific page. The page ID is used for the URL, the filename, and to create crossreference links.
83
+
The page ID is a unique string that identifies each page on the documentation site. You can view the page ID in the address bar of your browser when you're on a specific page. The page ID is used for the URL, the filename, and to create cross-reference links.
68
84
69
85
For example, if you're viewing this page, the URL in your browser's address bar will look similar to:
70
86
@@ -85,7 +101,7 @@ When creating a new page, you need to set the page ID in the source file. The pa
85
101
[#my-new-page]
86
102
```
87
103
+
88
-
Replace `my-new-page` with the desired page ID for your new page.
104
+
Replace `my-new-page` with the page ID for your new page.
89
105
. Save the file.
90
106
91
107
NOTE: Page IDs must be unique across the entire documentation site. If you try to use an existing page ID, you'll get a build error.
0 commit comments