Merge pull request #18 from apache/task/website-build-4b728a5f929e2aa15b7ed9744859b99c7cf013b9
New website build 4b728a5f929e2aa15b7ed9744859b99c7cf013b9
diff --git a/contributing/documentation.html b/contributing/documentation.html
index e0201d4..4753ee3 100644
--- a/contributing/documentation.html
+++ b/contributing/documentation.html
@@ -180,25 +180,25 @@
<li>Tool name: <code>javadoc2markdown</code></li>
<li><a href="https://dev.azure.com/lucene-net/Lucene.NET/_packaging?_a=feed&feed=lucene-net-tools">NuGet feed here</a></li>
</ul>
-<h3 id="building-the-docs">Building the docs</h3>
-<ul>
-<li>Checkout the Lucene.Net release tag to build the docs against</li>
-<li>Execute the <code>./websites/apidocs/docs.ps1</code> script to build and serve the api docs website locally for testing.
-<ul>
-<li>Example: <code>./websites/apidocs/docs.ps1 -LuceneNetVersion 4.8.0-beta00008</code></li>
-<li>will serve a website on <a href="http://localhost:8080">http://localhost:8080</a></li>
-<li>It will take quite a while (approx 10 minutes) to build</li>
-</ul>
-</li>
-</ul>
<h3 id="publishing-the-docs">Publishing the docs</h3>
+<div class="NOTE">
+<h5>Note</h5>
+<p>Before publishing, when testing locally ensure that both the "Improve this doc" button on each documentation page and the "View Source" button (when viewing a Class) links correctly to the newly created version branch on GitHub.</p>
+</div>
<ul>
-<li>Checkout the Git repo that hosts the documentation: <a href="https://github.com/apache/lucenenet-site/tree/asf-site">https://github.com/apache/lucenenet-site/tree/asf-site</a> <em>(ensure you have <code>asf-site</code> branch checked out, not <code>master</code>)</em></li>
-<li>Create a new folder in this repo: <code>/docs/[Version]</code>, for example: <code>/docs/4.8.0-beta00008</code></li>
-<li>Copy the build output of the documentation site to this new folder. The build output will be all of the files in the <code>./websites/apidocs/_site</code> in your main Lucene.NET checked out Git repository.</li>
-<li>Commit and push these changes</li>
-<li>The new version documentation will be live. Due to the amount of new files committed, the new files may take up to 60 minutes to become live.</li>
-<li>Next the website needs updating which is a manual process currently:
+<li><p>Create and checkout a new branch based on the release tag on the main branch with the name: <code>docs/[Version]</code>, for example <code>docs/4.8.0-beta00008</code>. This branch is used for linking to on the API docs "Improve this Doc" and "View Source" buttons. Then build the docs, for example: <code>./websites/apidocs/docs.ps1 -LuceneNetVersion 4.8.0-beta00008</code> (For testing <a href="#build-script-1">see above</a>).</p>
+</li>
+<li><p>Commit and push any changes you may need to make for the API docs.</p>
+</li>
+<li><p>Checkout the Git repo that hosts the documentation: <a href="https://github.com/apache/lucenenet-site/tree/asf-site">https://github.com/apache/lucenenet-site/tree/asf-site</a> <em>(ensure you have <code>asf-site</code> branch checked out, not <code>master</code>)</em>.</p>
+</li>
+<li><p>Create a new folder in this repo: <code>/docs/[Version]</code>, for example: <code>/docs/4.8.0-beta00008</code>.</p>
+</li>
+<li><p>Copy the build output of the documentation site to this new folder. The build output will be all of the files in the <code>./websites/apidocs/_site</code> in your main Lucene.NET checked out Git repository. Commit and push these changes.</p>
+</li>
+<li><p>The new version documentation will be live. Due to the amount of new files committed, the new files may take up to 60 minutes to become live.</p>
+</li>
+<li><p>Next the website needs updating which is a manual process currently:</p>
<ul>
<li>In the <code>./websites/site/download</code> folder there should be a document per release. It's normally fine to copy the document of the latest release for the same major version. For a new major version some modifications may be needed.</li>
<li>Ensure the correct version number is listed in the header and the NuGet download snippet.</li>
@@ -209,7 +209,6 @@
<li><a href="#website">Build the website</a> and test locally, then deploy the changes</li>
</ul>
</li>
-<li>Once the website is committed/pushed, the last step is to create a named branch on the main <a href="https://github.com/apache/lucenenet"><code>lucenenet</code></a> repository with the name: <code>docs/[Version]</code>, for example <code>docs/4.8.0-beta00008</code> based on commit of the latest (if any) changes made to the docs in the <code>lucenenet</code> repository on the main branch. This branch is used for linking to on the API docs "Improve this Doc" button.</li>
</ul>
</article>
</div>
diff --git a/contributing/make-release.html b/contributing/make-release.html
index 611eb4f..7ba1dfd 100644
--- a/contributing/make-release.html
+++ b/contributing/make-release.html
@@ -331,20 +331,7 @@
<li>Commit changes and <a href="https://lucenenet.apache.org/contributing/documentation.html#website">publish the website</a>.</li>
</ul>
<h3 id="update-the-api-documentation-with-new-release">Update the API Documentation with new release</h3>
-<ul>
-<li>Create and push a new Git branch from the relese tag called <code>docs/[version]</code>, for example: <code>docs/4.8.0-beta00008</code>.</li>
-<li>Update the DocFx config file <code>/websites/apidocs/docfx.json</code> and change the <code>globalMetadata</code> section:
-<ul>
-<li><code>_appTitle</code> should be: "Apache Lucene.NET [Version] Documentation"</li>
-<li>ensure the <code>_appFooter</code> has the correct copyright year</li>
-<li>the <code>_gitContribute.branch</code> should be the name of the branch just created</li>
-</ul>
-</li>
-<li>Follow the instructions on how to <a href="https://lucenenet.apache.org/contributing/documentation.html#api-docs">build, test and publish the docs</a> and run/test the docs locally. When testing locally ensure that the "Improve this doc" button on each documentation page links to the newly created branch on GitHub.</li>
-<li>Commit and push any changes done during the docs building process to the new branch.</li>
-<li>Merge the new branch to the <code>master</code> branch, or create a Pull Request to target the <code>master</code> branch if you want to review changes that way or want another team member to review changes.</li>
-<li><a href="https://lucenenet.apache.org/contributing/documentation.html#api-docs">Publish the docs</a>.</li>
-</ul>
+<p>Follow the instructions on how to <a href="https://lucenenet.apache.org/contributing/documentation.html#api-docs">build</a>, test and <a href="https://lucenenet.apache.org/contributing/documentation.html#publishing-the-docs">publish</a> the docs.</p>
<h3 id="post-release-steps">Post-Release Steps</h3>
<ul>
<li><p>Log the new version at <a href="https://reporter.apache.org/addrelease.html?lucenenet">https://reporter.apache.org/addrelease.html?lucenenet</a></p>
diff --git a/manifest.json b/manifest.json
index 89c27b5..b15bfa1 100644
--- a/manifest.json
+++ b/manifest.json
@@ -77,7 +77,7 @@
"output": {
".html": {
"relative_path": "contributing/documentation.html",
- "hash": "i7mojsieifGIvu6QrgJcvw=="
+ "hash": "0tLnP8AWdzijET6sWdX2OQ=="
}
},
"is_incremental": false,
@@ -125,7 +125,7 @@
"output": {
".html": {
"relative_path": "contributing/make-release.html",
- "hash": "xVBempL0ENbEvGifXUf8YQ=="
+ "hash": "HJ+R5aLi1kf/rhDJwaxkKQ=="
}
},
"is_incremental": false,
