You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2021/03/24 03:34:39 UTC
[lucenenet] 05/05: website: Updated website documentation to
include a note about the mini-site DocFx configuration files being active
and the "main" one currently only there in case we need to revert.
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
commit f259bb63e2b67999aa3ecaa86f9457b1d03d63f3
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Wed Mar 24 03:03:00 2021 +0700
website: Updated website documentation to include a note about the mini-site DocFx configuration files being active and the "main" one currently only there in case we need to revert.
---
websites/site/contributing/documentation.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/websites/site/contributing/documentation.md b/websites/site/contributing/documentation.md
index 8728d64..1b7471e 100644
--- a/websites/site/contributing/documentation.md
+++ b/websites/site/contributing/documentation.md
@@ -103,6 +103,9 @@ The file/folder structure is within `/websites/apidocs`:
- `tools/*` - during the build process some tools will be downloaded which are stored here
- `_site` - this is the exported static site that is generated
+> [!NOTE]
+> The project is going through a trial run of using mini-sites instead of a single API docs site. Currently, the active DocFx configuration files are the `docfx.<project>.json` files, however both the mini-site and `docfx.json` configuration files need to be updated, since there is a chance we will need to switch back.
+
### Process overview
The documentation generation is a complex process because it needs to convert the Java Lucene project's documentation into a usable format to produce the output Lucene.NET's documentation.