Skip to content

Commit d46736e

Browse files
authored
Merge pull request wildfly#18820 from jmesnil/doc_readme
Update doc's README
2 parents bf738d4 + 620a911 commit d46736e

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

docs/README.adoc

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,23 @@ Once copied you'll need to add the directory to the git repository; `git add ./1
7777

7878
=== Edit and Build Index
7979

80-
Next in the `wildfly.github.io` repository you'll need to edit the `index.adoc` and add the newly created directory. We
81-
try to keep the listings in release order with the new release on top.
80+
Next in the `wildfly.github.io` repository you'll need to add the newly created directory and link to it from the index page.
8281

83-
Once you edit the `index.adoc` you'll need to regenerate the `index.html` file. This can be done with the `asciidoctor`
82+
In the `index.adoc`, edit the `:wildfly-latest-major:` attribute to set it to the new release of WildFly (only the major version).
83+
84+
In the `archives.adoc`, add a table row for the previous version of WildFly.
85+
86+
Once you edit these 2 files, you'll need to regenerate their HTML files. This can be done with the `asciidoctor`
8487
command.
8588

8689
```
87-
asciidoctor index.adoc
90+
asciidoctor index.adoc archives.adoc
8891
```
8992

93+
=== Update the Docs sitemap
94+
95+
In your `wildfly.github.io` checkout, edit the `sitemap.xml` file. In all lines with URLs that include the previous WildFly version, update to the new WildFly version.
96+
97+
=== Submit Your Changes
98+
9099
After all that is complete you can commit your changes and submit a PR.

0 commit comments

Comments
 (0)