Skip to content

Commit 2237cdf

Browse files
committed
Yet more wording refinements.
Signed-off-by: Dean Wampler <dean.wampler@ibm.com>
1 parent ba68b8f commit 2237cdf

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Next Steps after running the script:
2121
1. Go to [https://github.com/The-AI-Alliance](https://github.com/The-AI-Alliance) and create a _public_ repo named with the same name you used. If you don't have permissions, ask Dean Wampler, Adam Pingel, Joe Olson, or Trevor Grant to do this.
2222
3. Follow the instructions given for adding a remote (upstream) location to your local repo. If someone else creates the repo for you, remind them to give you the instructions!
2323
4. Push your local content up to the remote repo! TIP: Make sure both the `main` and `latest` branches are pushed upstream.
24-
5. In GitHub, go to the repo Settings, "Pages" section (left-hand side) to set up GitHub Pages publishing. You want to select `docs` as the folder from which the site is published and `latest` as the branch.
24+
5. In GitHub, go to the repo Settings, "Pages" section (left-hand side) to set up GitHub Pages publishing. You want to select `docs` as the folder from which the site is published and `latest` as the branch. (There are more detail instructions in the `README.md` generated for your site, if needed.)
2525

2626
A simpler experience is just to use `main` as the publication branch, so every merge to `main` automatically publishes your updated content. If you really want to do this, ask Dean Wampler for help.
2727

create-microsite.sh

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,29 @@ Done! The current working directory is $PWD.
234234
235235
Next Steps:
236236
237+
1. Go to https://github.com/The-AI-Alliance and create a _public_ repo named with the same name you used.
238+
If you don't have permissions, ask Dean Wampler, Adam Pingel, Joe Olson, or Trevor Grant to do this.
239+
3. Follow the instructions given for adding a remote (upstream) location to your local repo.
240+
If someone else creates the repo for you, remind them to give you the instructions!
241+
4. Push your local content up to the remote repo! TIP: Make sure both the "main" and "latest" branches are
242+
pushed upstream.
243+
5. In GitHub, go to the repo Settings, "Pages" section (left-hand side) to set up GitHub Pages publishing.
244+
You want to select "docs" as the folder from which the site is published and "latest" as the branch.
245+
(There are more detail instructions in the "README.md" generated for your site, if needed.)
246+
247+
A simpler experience is just to use "main" as the publication branch, so every merge to "main"
248+
automatically publishes your updated content. If you really want to do this, ask Dean Wampler for help.
249+
250+
Next, replace the placeholder text and "*.markdown" files with your real content, e.g.,
251+
252+
1. Replace all occurrences of "TODO" with appropriate content.
253+
2. Rename or delete the "second_page.markdown". Copy it to add more top-level pages, but change the
254+
"nav_order" field!
255+
3. Use the "nested" directory content as an example of nesting content or delete it if you don't need it.
256+
4. Make any changes you want to make in the "docs/_config.yml" file. (None are required.)
257+
258+
See also the "README.md" that was created in your new repo for more tips and guidance on development tasks.
259+
237260
1. Go to https://github.com/The-AI-Alliance and create a repo named "$repo_name".
238261
If you don't have permissions, as Dean Wampler, Adam Pingel, Joe Olson, or Trevor Grant to do this.
239262
2. Follow the instructions given for adding a remote (upstream) location to your local repo.

0 commit comments

Comments
 (0)