This is an automated email from the ASF dual-hosted git repository.
shazwazza pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
The following commit(s) were added to refs/heads/master by this push:
new 4b728a5 Updates apidocs release docs
4b728a5 is described below
commit 4b728a5f929e2aa15b7ed9744859b99c7cf013b9
Author: Shannon <[email protected]>
AuthorDate: Mon Apr 19 12:54:10 2021 +1000
Updates apidocs release docs
---
websites/site/contributing/documentation.md | 20 ++++++++------------
websites/site/contributing/make-release.md | 10 +---------
2 files changed, 9 insertions(+), 21 deletions(-)
diff --git a/websites/site/contributing/documentation.md
b/websites/site/contributing/documentation.md
index 80fe2b1..ea1caaf 100644
--- a/websites/site/contributing/documentation.md
+++ b/websites/site/contributing/documentation.md
@@ -146,20 +146,17 @@ Once pushed, you can merge those changes to the `master`
branch. Doing this may
- Tool name: `javadoc2markdown`
- [NuGet feed
here](https://dev.azure.com/lucene-net/Lucene.NET/_packaging?_a=feed&feed=lucene-net-tools)
-### Building the docs
+### Publishing the docs
-- Checkout the Lucene.Net release tag to build the docs against
-- Execute the `./websites/apidocs/docs.ps1` script to build and serve the api
docs website locally for testing.
- - Example: `./websites/apidocs/docs.ps1 -LuceneNetVersion 4.8.0-beta00008`
- - will serve a website on [http://localhost:8080](http://localhost:8080)
- - It will take quite a while (approx 10 minutes) to build
+> [!NOTE]
+> 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.
-### Publishing the docs
+- Create and checkout a new branch based on the release tag on the main branch
with the name: `docs/[Version]`, for example `docs/4.8.0-beta00008`. This
branch is used for linking to on the API docs "Improve this Doc" and "View
Source" buttons. Then build the docs, for example: `./websites/apidocs/docs.ps1
-LuceneNetVersion 4.8.0-beta00008` (For testing [see above](#build-script-1)).
+- Commit and push any changes you may need to make for the API docs.
-- Checkout the Git repo that hosts the documentation:
https://github.com/apache/lucenenet-site/tree/asf-site _(ensure you have
`asf-site` branch checked out, not `master`)_
-- Create a new folder in this repo: `/docs/[Version]`, for example:
`/docs/4.8.0-beta00008`
-- Copy the build output of the documentation site to this new folder. The
build output will be all of the files in the `./websites/apidocs/_site` in your
main Lucene.NET checked out Git repository.
-- Commit and push these changes
+- Checkout the Git repo that hosts the documentation:
https://github.com/apache/lucenenet-site/tree/asf-site _(ensure you have
`asf-site` branch checked out, not `master`)_.
+- Create a new folder in this repo: `/docs/[Version]`, for example:
`/docs/4.8.0-beta00008`.
+- Copy the build output of the documentation site to this new folder. The
build output will be all of the files in the `./websites/apidocs/_site` in your
main Lucene.NET checked out Git repository. Commit and push these changes.
- 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.
- Next the website needs updating which is a manual process currently:
- In the `./websites/site/download` 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.
@@ -169,4 +166,3 @@ Once pushed, you can merge those changes to the `master`
branch. Doing this may
- Update the `./websites/site/download/toc.yml` and
`./websites/site/download/download.md` files to include a reference to the new
page which should maintain descending version order.
- Update the `./websites/site/docs.md` file and add a link to the new
documentation for the current version which should maintain descending version
order.
- [Build the website](#website) and test locally, then deploy the changes
-- Once the website is committed/pushed, the last step is to create a named
branch on the main [`lucenenet`](https://github.com/apache/lucenenet)
repository with the name: `docs/[Version]`, for example `docs/4.8.0-beta00008`
based on commit of the latest (if any) changes made to the docs in the
`lucenenet` repository on the main branch. This branch is used for linking to
on the API docs "Improve this Doc" button.
diff --git a/websites/site/contributing/make-release.md
b/websites/site/contributing/make-release.md
index 617ffe3..fd61a0f 100644
--- a/websites/site/contributing/make-release.md
+++ b/websites/site/contributing/make-release.md
@@ -275,15 +275,7 @@ Remove the old releases from SVN under
https://dist.apache.org/repos/dist/releas
### Update the API Documentation with new release
-- Create and push a new Git branch from the relese tag called
`docs/[version]`, for example: `docs/4.8.0-beta00008`.
-- Update the DocFx config file `/websites/apidocs/docfx.json` and change the
`globalMetadata` section:
- - `_appTitle` should be: "Apache Lucene.NET [Version] Documentation"
- - ensure the `_appFooter` has the correct copyright year
- - the `_gitContribute.branch` should be the name of the branch just created
-- Follow the instructions on how to [build, test and publish the
docs](https://lucenenet.apache.org/contributing/documentation.html#api-docs)
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.
-- Commit and push any changes done during the docs building process to the new
branch.
-- Merge the new branch to the `master` branch, or create a Pull Request to
target the `master` branch if you want to review changes that way or want
another team member to review changes.
-- [Publish the
docs](https://lucenenet.apache.org/contributing/documentation.html#api-docs).
+Follow the instructions on how to
[build](https://lucenenet.apache.org/contributing/documentation.html#api-docs),
test and
[publish](https://lucenenet.apache.org/contributing/documentation.html#publishing-the-docs)
the docs.
### Post-Release Steps
