Skip to content

Commit

Permalink
8293202: Document how to edit doc/testing, doc/building
Browse files Browse the repository at this point in the history
Reviewed-by: erikj
  • Loading branch information
LudwikJaniuk authored and erikj79 committed Sep 1, 2022
1 parent 07616de commit 7c2f299
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/building.html
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ <h1 class="title">Building the JDK</h1>
<li><a href="#developing-the-build-system-itself">Developing the Build System Itself</a></li>
</ul></li>
<li><a href="#contributing-to-the-jdk">Contributing to the JDK</a></li>
<li><a href="#editing-this-document">Editing this document</a></li>
</ul>
</nav>
<h2 id="tldr-instructions-for-the-impatient">TL;DR (Instructions for the Impatient)</h2>
Expand Down Expand Up @@ -1033,5 +1034,7 @@ <h2 id="contributing-to-the-jdk">Contributing to the JDK</h2>
<p>First of all: Thank you! We gladly welcome your contribution. However, please bear in mind that the JDK is a massive project, and we must ask you to follow our rules and guidelines to be able to accept your contribution.</p>
<p>The official place to start is the <a href="http://openjdk.java.net/contribute/">'How to contribute' page</a>. There is also an official (but somewhat outdated and skimpy on details) <a href="http://openjdk.java.net/guide/">Developer's Guide</a>.</p>
<p>If this seems overwhelming to you, the Adoption Group is there to help you! A good place to start is their <a href="https://wiki.openjdk.java.net/display/Adoption/New+Contributor">'New Contributor' page</a>, or start reading the comprehensive <a href="https://adoptopenjdk.gitbooks.io/adoptopenjdk-getting-started-kit/en/">Getting Started Kit</a>. The Adoption Group will also happily answer any questions you have about contributing. Contact them by <a href="http://mail.openjdk.java.net/mailman/listinfo/adoption-discuss">mail</a> or <a href="http://openjdk.java.net/irc/">IRC</a>.</p>
<h2 id="editing-this-document">Editing this document</h2>
<p>If you want to contribute changes to this document, edit <code>doc/building.md</code> and then run <code>make update-build-docs</code> to generate the same changes in <code>doc/building.html</code>.</p>
</body>
</html>
6 changes: 6 additions & 0 deletions doc/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -1948,6 +1948,12 @@ contributing. Contact them by [mail](
http://mail.openjdk.java.net/mailman/listinfo/adoption-discuss) or [IRC](
http://openjdk.java.net/irc/).
## Editing this document
If you want to contribute changes to this document, edit `doc/building.md` and
then run `make update-build-docs` to generate the same changes in
`doc/building.html`.
---
# Override styles from the base CSS file that are not ideal for this document.
header-includes:
Expand Down
3 changes: 3 additions & 0 deletions doc/testing.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ <h1 class="title">Testing the JDK</h1>
<li><a href="#pkcs11-tests">PKCS11 Tests</a></li>
<li><a href="#client-ui-tests">Client UI Tests</a></li>
</ul></li>
<li><a href="#editing-this-document">Editing this document</a></li>
</ul>
</nav>
<h2 id="using-make-test-the-run-test-framework">Using &quot;make test&quot; (the run-test framework)</h2>
Expand Down Expand Up @@ -254,5 +255,7 @@ <h4 id="linux">Linux</h4>
<h4 id="windows">Windows</h4>
<p>Type <code>gpedit</code> in the Search and then click Edit group policy; navigate to User Configuration -&gt; Administrative Templates -&gt; Windows Components -&gt; File Explorer; in the right-side pane look for &quot;Turn off Windows key hotkeys&quot; and double click on it; enable or disable hotkeys.</p>
<p>Note: restart is required to make the settings take effect.</p>
<h2 id="editing-this-document">Editing this document</h2>
<p>If you want to contribute changes to this document, edit <code>doc/testing.md</code> and then run <code>make update-build-docs</code> to generate the same changes in <code>doc/testing.html</code>.</p>
</body>
</html>
6 changes: 6 additions & 0 deletions doc/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,12 @@ double click on it; enable or disable hotkeys.

Note: restart is required to make the settings take effect.

## Editing this document

If you want to contribute changes to this document, edit `doc/testing.md` and
then run `make update-build-docs` to generate the same changes in
`doc/testing.html`.

---
# Override some definitions in the global css file that are not optimal for
# this document.
Expand Down

0 comments on commit 7c2f299

Please sign in to comment.