lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lai...@apache.org
Subject [lucenenet-site] branch master updated: Updates some info about the website & api docs and fixes links for v3 download
Date Mon, 25 Feb 2019 20:27:56 GMT
This is an automated email from the ASF dual-hosted git repository.

laimis pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet-site.git


The following commit(s) were added to refs/heads/master by this push:
     new 6a39269  Updates some info about the website & api docs and fixes links for v3
download
     new af4974c  Merge pull request #2 from Shazwazza/website-info-update
6a39269 is described below

commit 6a392695193675558494f176f0da6870c427ee3e
Author: Shannon <sdeminick@gmail.com>
AuthorDate: Mon Feb 25 10:59:21 2019 +1100

    Updates some info about the website & api docs and fixes links for v3 download
---
 contributing/documentation.html | 26 +++++++++++++++++++++++---
 contributing/toc.html           |  2 +-
 download/version-3.html         | 16 ++++++++--------
 3 files changed, 32 insertions(+), 12 deletions(-)

diff --git a/contributing/documentation.html b/contributing/documentation.html
index 2a85bac..ca87b0e 100644
--- a/contributing/documentation.html
+++ b/contributing/documentation.html
@@ -74,10 +74,13 @@
 <h1 id="documentation--website">Documentation &amp; Website</h1>
 
 <hr>
-<p><em>If you wish to help out with this website and the API documentation site,
here's some info that you'll need</em></p>
+<p><em>Details about this website and the API documentation site and how to help
contribute to them</em></p>
+<h2 id="overview">Overview</h2>
+<p>The website and the api documentation source code is found in the same Git repository
as the Lucene.Net code in the folder: <code>/websites/</code>. The site is built
with a static site generator called <a href="https://dotnet.github.io/docfx/">DocFx</a>
and all of the content/pages are created using Markdown files.</p>
+<p>To submit changes for the website, create a Pull Request to the <a href="https://github.com/apache/lucenenet">Lucene
Git repositoriy</a>. (See <a class="xref" href="index.html#submit-a-pull-request">Contributing</a>
for details)</p>
 <h2 id="website">Website</h2>
-<p>The website source code is found in the same Git repository as the Lucene.Net code
in the folder: <code>/websites/site</code>. The site is built with a static site
generator called <a href="https://dotnet.github.io/docfx/">DocFx</a> and all of
the content/pages are created using Markdown files.</p>
-<p>To build the website and run it on your machine, run the powershell script: <code>/websites/site/site.ps1</code>.
You don't have to pass any parameters in and it will build the site and host it at <a href="http://localhost:8080">http://localhost:8080</a>.
There are 2 parameters that you can use:</p>
+<p>To build the website and run it on your machine, run the powershell script: <code>/websites/site/site.ps1</code>.
You don't have to pass any parameters in and it will build the site and host it at <a href="http://localhost:8080">http://localhost:8080</a>.</p>
+<p>The script has 2 optional parameters:</p>
 <ul>
 <li><code>-ServeDocs</code> <em>(default is 1)</em> The value
of <code>1</code> means it will build the docs and host the site, if <code>0</code>
is specified, it will build the static site to be hosted elsewhere.</li>
 <li><code>-Clean</code> <em>(default is 0)</em> The value of
<code>1</code> means that it will clear all caches and tool files before it builds
again. This is handy if a new version of docfx is available or if there's odd things occuring
with the incremental build.</li>
@@ -86,10 +89,27 @@
 <ul>
 <li><code>site.ps1</code> - the build script</li>
 <li><code>docfx.json</code> - the DocFx configuration file <em>(see
docfx manual for further info)</em></li>
+<li><code>lucenetemplate/*</code> - the custom template files to style
the website</li>
 <li><code>*.md</code> - the root site content such as the index and download
pages</li>
 <li><code>toc.yml</code> - these files determine the menu structures <em>(see
docfx manual for further info)</em></li>
 <li><code>contributing/*</code> - the Contributing section</li>
+<li><code>tools/*</code> - during the build process some tools will be
downloaded which are stored here</li>
+<li><code>_site</code> - this is the exported static site that is generated</li>
+</ul>
+<h2 id="api-docs">API Docs</h2>
+<p>To build the api docs and run it on your machine, run the powershell script: <code>/websites/apidocs/docs.ps1</code>.
You don't have to pass any parameters in and it will build the site and host it at <a href="http://localhost:8080">http://localhost:8080</a>.</p>
+<p>The script has 2 optional parameters:</p>
+<ul>
+<li><code>-ServeDocs</code> <em>(default is 1)</em> The value
of <code>1</code> means it will build the docs and host the site, if <code>0</code>
is specified, it will build the static site to be hosted elsewhere.</li>
+<li><code>-Clean</code> <em>(default is 0)</em> The value of
<code>1</code> means that it will clear all caches and tool files before it builds
again. This is handy if a new version of docfx is available or if there's odd things occuring
with the incremental build.</li>
+</ul>
+<p>The file/folder structure is within <code>/websites/apidocs</code>:</p>
+<ul>
+<li><code>docs.ps1</code> - the build script</li>
+<li><code>docfx.json</code> - the DocFx configuration file <em>(see
docfx manual for further info)</em></li>
 <li><code>lucenetemplate/*</code> - the custom template files to style
the website</li>
+<li><code>*.md</code> - the root site content such as the index and download
pages</li>
+<li><code>toc.yml</code> - these files determine the menu structures <em>(see
docfx manual for further info)</em></li>
 <li><code>tools/*</code> - during the build process some tools will be
downloaded which are stored here</li>
 <li><code>_site</code> - this is the exported static site that is generated</li>
 </ul>
diff --git a/contributing/toc.html b/contributing/toc.html
index f52de48..56d9fee 100644
--- a/contributing/toc.html
+++ b/contributing/toc.html
@@ -24,7 +24,7 @@
                     <a href="wiki.html" name="" title="Wiki">Wiki</a>
                 </li>
                 <li>
-                    <a href="documentation.html" name="" title="Documentation">Documentation</a>
+                    <a href="documentation.html" name="" title="Website &amp; Docs">Website
&amp; Docs</a>
                 </li>
                 <li>
                     <a href="current-status.html" name="" title="Current status">Current
status</a>
diff --git a/download/version-3.html b/download/version-3.html
index 9d879ad..2c90e48 100644
--- a/download/version-3.html
+++ b/download/version-3.html
@@ -99,14 +99,14 @@
 </ul>
 <h3 id="binary-releases">Binary releases</h3>
 <ul>
-<li><a href="https://www-us.apache.org/dist//lucenenet/Apache-Lucene.Net-3.0.3-RC2.bin.zip">Binary</a>
- / <a href="http://archive.apache.org/dist/lucenenet/Apache-Lucene.Net-3.0.3-RC2.bin.zip.asc">PGP
Signature</a>
- / <a href="http://archive.apache.org/dist/lucenenet/Apache-Lucene.Net-3.0.3-RC2.bin.zip.sha1">SHA1
Checksum</a>
- / <a href="http://archive.apache.org/dist/lucenenet/Apache-Lucene.Net-3.0.3-RC2.bin.zip.md5">MD5
Checksum</a> </li>
-<li><a href="https://www-us.apache.org/dist//lucenenet/Apache-Lucene.Net-3.0.3-RC2.src.zip">Source</a>
- / <a href="http://archive.apache.org/dist/lucenenet/Apache-Lucene.Net-3.0.3-RC2.src.zip.asc">PGP
Signature</a>
- / <a href="http://archive.apache.org/dist/lucenenet/Apache-Lucene.Net-3.0.3-RC2.src.zip.sha1">SHA1
Checksum</a>
- / <a href="http://archive.apache.org/dist/lucenenet/Apache-Lucene.Net-3.0.3-RC2.src.zip.md5">MD5
Checksum</a> </li>
+<li><a href="https://www.apache.org/dist/lucenenet/3.0.3-RC2/Apache-Lucene.Net-3.0.3-RC2.bin.zip">Binary</a>
+ / <a href="https://www.apache.org/dist/lucenenet/3.0.3-RC2/Apache-Lucene.Net-3.0.3-RC2.bin.zip.asc">PGP
Signature</a>
+ / <a href="https://www.apache.org/dist/lucenenet/3.0.3-RC2/Apache-Lucene.Net-3.0.3-RC2.bin.zip.sha1">SHA1
Checksum</a>
+ / <a href="https://www.apache.org/dist/lucenenet/3.0.3-RC2/Apache-Lucene.Net-3.0.3-RC2.bin.zip.md5">MD5
Checksum</a> </li>
+<li><a href="https://www.apache.org/dist/lucenenet/3.0.3-RC2/Apache-Lucene.Net-3.0.3-RC2.src.zip">Source</a>
+ / <a href="https://www.apache.org/dist/lucenenet/3.0.3-RC2/Apache-Lucene.Net-3.0.3-RC2.src.zip.asc">PGP
Signature</a>
+ / <a href="https://www.apache.org/dist/lucenenet/3.0.3-RC2/Apache-Lucene.Net-3.0.3-RC2.src.zip.sha1">SHA1
Checksum</a>
+ / <a href="https://www.apache.org/dist/lucenenet/3.0.3-RC2/Apache-Lucene.Net-3.0.3-RC2.src.zip.md5">MD5
Checksum</a> </li>
 </ul>
 <p>The above release files should be verified using the PGP signatures and the
 <a href="https://www.apache.org/dist/lucenenet/KEYS">project release KEYS</a>.
See


Mime
View raw message