Skip to content

Commit 4b728a5

Browse files
committed
Updates apidocs release docs
1 parent e3e16d5 commit 4b728a5

File tree

2 files changed

+9
-21
lines changed

2 files changed

+9
-21
lines changed

websites/site/contributing/documentation.md

+8-12
Original file line numberDiff line numberDiff line change
@@ -146,20 +146,17 @@ Once pushed, you can merge those changes to the `master` branch. Doing this may
146146
- Tool name: `javadoc2markdown`
147147
- [NuGet feed here](https://dev.azure.com/lucene-net/Lucene.NET/_packaging?_a=feed&feed=lucene-net-tools)
148148

149-
### Building the docs
149+
### Publishing the docs
150150

151-
- Checkout the Lucene.Net release tag to build the docs against
152-
- Execute the `./websites/apidocs/docs.ps1` script to build and serve the api docs website locally for testing.
153-
- Example: `./websites/apidocs/docs.ps1 -LuceneNetVersion 4.8.0-beta00008`
154-
- will serve a website on [http://localhost:8080](http://localhost:8080)
155-
- It will take quite a while (approx 10 minutes) to build
151+
> [!NOTE]
152+
> 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.
156153
157-
### Publishing the docs
154+
- 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)).
155+
- Commit and push any changes you may need to make for the API docs.
158156

159-
- 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`)_
160-
- Create a new folder in this repo: `/docs/[Version]`, for example: `/docs/4.8.0-beta00008`
161-
- 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.
162-
- Commit and push these changes
157+
- 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`)_.
158+
- Create a new folder in this repo: `/docs/[Version]`, for example: `/docs/4.8.0-beta00008`.
159+
- 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.
163160
- 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.
164161
- Next the website needs updating which is a manual process currently:
165162
- 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
169166
- 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.
170167
- 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.
171168
- [Build the website](#website) and test locally, then deploy the changes
172-
- 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.

websites/site/contributing/make-release.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -275,15 +275,7 @@ Remove the old releases from SVN under https://dist.apache.org/repos/dist/releas
275275

276276
### Update the API Documentation with new release
277277

278-
- Create and push a new Git branch from the relese tag called `docs/[version]`, for example: `docs/4.8.0-beta00008`.
279-
- Update the DocFx config file `/websites/apidocs/docfx.json` and change the `globalMetadata` section:
280-
- `_appTitle` should be: "Apache Lucene.NET [Version] Documentation"
281-
- ensure the `_appFooter` has the correct copyright year
282-
- the `_gitContribute.branch` should be the name of the branch just created
283-
- 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.
284-
- Commit and push any changes done during the docs building process to the new branch.
285-
- 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.
286-
- [Publish the docs](https://lucenenet.apache.org/contributing/documentation.html#api-docs).
278+
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.
287279

288280
### Post-Release Steps
289281

0 commit comments

Comments
 (0)