lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From shazwa...@apache.org
Subject [lucenenet] branch docs-may updated: adds further description of publishing the docs
Date Thu, 21 May 2020 04:36:21 GMT
This is an automated email from the ASF dual-hosted git repository.

shazwazza pushed a commit to branch docs-may
in repository https://gitbox.apache.org/repos/asf/lucenenet.git


The following commit(s) were added to refs/heads/docs-may by this push:
     new ed6d047  adds further description of publishing the docs
ed6d047 is described below

commit ed6d0475083b314c4000ef842c3136eb5053df40
Author: Shannon <sdeminick@gmail.com>
AuthorDate: Thu May 21 14:36:07 2020 +1000

    adds further description of publishing the docs
---
 websites/site/contributing/documentation.md | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/websites/site/contributing/documentation.md b/websites/site/contributing/documentation.md
index 64f52ec..5dc5134 100644
--- a/websites/site/contributing/documentation.md
+++ b/websites/site/contributing/documentation.md
@@ -70,7 +70,7 @@ The process overview is:
 
 * Use the `JavaDocToMarkdownConverter` project within the `DocumentationTools.sln` solution
to run the conversion of the Java Lucene projects docs into a useable format for DocFx. This
tool takes uses a release tag output of the Java Lucene project as it's source to convert
against the Lucene.Net's source. 
 * Run the documentation build script to produce the documentation site
-* Publish the output to the [`lucenenet-site`](https://github.com/apache/lucenenet-site)
repository into a correpsonding named version directory and branch
+* Publish the output to the [`lucenenet-site`](https://github.com/apache/lucenenet-site)
repository into a correpsonding named version directory
 
 We don't want to manually change the converted resulting markdown files (`.md`) because they
would get overwritten again when the conversion process is re-executed. Therefor to fix any
formatting issues or customized output of the project docs, these customizations/fixes/tweaks
are built directly in to the conversion process itself in the `JavaDocToMarkdownConverter.csproj`
project.
 
@@ -84,10 +84,10 @@ We don't want to manually change the converted resulting markdown files
(`.md`)
   * Many times there will just be whitespace changes in the files especially if this process
has been executed before for the same source/destination version.
   * If this is a new source/destination version there will be a **lot** of file changes,
at least one file per folder.
   * If there are formatting issues or irregularities in the converted output then these will
need to be addressed by making changes to the conversion tool itself `JavaDocToMarkdownConverter.csproj`
(generally only needed for new major version releases)
-* Execute the `./websites/apidocs/docs.ps1` script to build and serve the api docs website
locally for testing 
+* 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
-  * Example: `./websites/apidocs/docs.ps1 -LuceneNetVersion 4.8.0-beta00008`
   
 
 ### Publishing the docs
@@ -96,4 +96,5 @@ We don't want to manually change the converted resulting markdown files
(`.md`)
 * 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 20 minutes to become live. 
\ No newline at end of file
+* The new version documentation will be live. Due to the amount of new files committed, the
new files may take up to 20 minutes to become live. 
+* Create a named branch on the main [`lucenenet`](https://github.com/apache/lucenenet) repository
with the same 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. This branch is
used for linking to on the API docs "Improve this Doc" button.
\ No newline at end of file


Mime
View raw message