This is an automated email from the ASF dual-hosted git repository.
richardantal pushed a commit to branch asf-site-staging
in repository https://gitbox.apache.org/repos/asf/phoenix-site.git
The following commit(s) were added to refs/heads/asf-site-staging by this push:
new 50339aaa PHOENIX-6672: update building_website.html to mention git
instead of svn (#4)
50339aaa is described below
commit 50339aaa26a425d97bde8e2f7a48aa514328e57b
Author: richardantal <[email protected]>
AuthorDate: Mon Jan 12 09:44:30 2026 +0100
PHOENIX-6672: update building_website.html to mention git instead of svn
(#4)
---
output/building_website.html | 9 +++--
output/dependency-info.html | 49 ++++++++++++++++++++---
output/language/datatypes.html | 2 +-
output/language/functions.html | 2 +-
output/language/index.html | 2 +-
output/licenses.html | 14 +++----
output/plugin-management.html | 19 +++++----
output/plugins.html | 34 ++++++++--------
output/project-info.html | 2 +-
output/summary.html | 38 +++++++++---------
site/source/pom.xml | 9 +++++
site/source/src/site/markdown/building_website.md | 11 ++---
12 files changed, 123 insertions(+), 68 deletions(-)
diff --git a/output/building_website.html b/output/building_website.html
index 508ff093..5222e594 100644
--- a/output/building_website.html
+++ b/output/building_website.html
@@ -174,14 +174,15 @@ Generated by Apache Maven Doxia
<li>Make a local copy of source markdown files and html web pages</li>
</ol>
<div class="source">
- <pre><code> $ svn checkout https://svn.apache.org/repos/asf/phoenix
+ <pre><code> $ git clone [email protected]:apache/phoenix-site.git
</code></pre>
</div>
<ol style="list-style-type: decimal">
<li>Edit/Add source markdown files in
<code>site/source/src/site/markdown</code> directory.</li>
<li>Edit <code>phoenix-docs/src/docsrc/help/phoenix.csv</code> to update
Reference pages, adding any missing new words to
<code>phoenix-docs/src/tools/org/h2/build/doc/dictionary.txt</code>.</li>
<li>Run <code>build.sh</code> located at root to generate/update html web
pages in <code>output</code> directory</li>
- <li><code>svn commit</code> source markdown files and html web pages</li>
+ <li><code>git commit</code> source markdown files and html web pages then
<code>git commit</code> and <code>git push</code></li>
+ <li>Create a pull request in GitHub for the <a class="externalLink"
href="https://github.com/apache/phoenix-site";>mirror of the Phoenix Site Git
repository</a>. Similarly to the GitHub workflow mentioned in the <a
href="contributing.html">contributing</a> page.</li>
</ol>
<h1>Local Testing During Development</h1>
<p>The site uses protocol-relative URLs for included assets to support
<code>http</code> as well as <code>https</code>. This can cause assets to fail
to load when working locally if not using a web server. The root cause is that
locally opened files use the <code>file:</code> protocol, but some assets live
on remote servers thus requiring the <code>http:</code> or <code>https:</code>
protocol.</p>
@@ -196,7 +197,7 @@ python -m SimpleHTTPServer 8000
<pre><code>python3 -m http.server 8000
</code></pre>
</div>
-<p>Now you can access the website at <code>http://localhost:8000/</code> and
your changes are available with a page refresh.</p>
+<p>Now you can access the website at <a class="externalLink"
href="http://localhost:8000";>http://localhost:8000</a> and your changes are
available with a page refresh.</p>
</main>
<div class="d-none d-sm-none d-md-none d-lg-none d-xl-block col-xl-2">
</div>
@@ -759,7 +760,7 @@ Reference
<div class="row">
<div class="col-md-12">
<p class="copyright">Copyright ©
-2025
+2026
<a href="http://www.apache.org";>Apache Software Foundation</a>
diff --git a/output/dependency-info.html b/output/dependency-info.html
index b9c50bff..344ecead 100644
--- a/output/dependency-info.html
+++ b/output/dependency-info.html
@@ -162,13 +162,52 @@ Generated by Apache Maven Doxia
</div>
<main class="col-xs-12 col-sm-12 col-md-12 col-lg-12 col-xl-8"
role="main">
<section>
- <a name="Maven_Coordinates"></a>
<div class="page-header">
<h2 id="Maven_Coordinates">Maven Coordinates</h2>
- </div>
+ </div><a name="Maven_Coordinates"></a>
<section>
- <a name="Apache_Maven"></a>
- <h3 id="Apache_Maven">Apache Maven</h3>
+ <h3 id="Apache_Maven">Apache Maven</h3><a name="Apache_Maven"></a>
+ <div>
+ <pre><dependency>
+ <groupId>org.apache.phoenix</groupId>
+ <artifactId>phoenix-site</artifactId>
+ <version>2.0.0-SNAPSHOT</version>
+</dependency></pre>
+ </div>
+ </section>
+ <section>
+ <h3 id="Apache_Ivy">Apache Ivy</h3><a name="Apache_Ivy"></a>
+ <div>
+ <pre><dependency org="org.apache.phoenix" name="phoenix-site"
rev="2.0.0-SNAPSHOT">
+ <artifact name="phoenix-site" type="jar" />
+</dependency></pre>
+ </div>
+ </section>
+ <section>
+ <h3 id="Groovy_Grape">Groovy Grape</h3><a name="Groovy_Grape"></a>
+ <div>
+ <pre>@Grapes(
+@Grab(group='org.apache.phoenix', module='phoenix-site',
version='2.0.0-SNAPSHOT')
+)</pre>
+ </div>
+ </section>
+ <section>
+ <h3 id="Gradle.2FGrails">Gradle/Grails</h3><a name="Gradle.2FGrails"></a>
+ <div>
+ <pre>implementation 'org.apache.phoenix:phoenix-site:2.0.0-SNAPSHOT'</pre>
+ </div>
+ </section>
+ <section>
+ <h3 id="Scala_SBT">Scala SBT</h3><a name="Scala_SBT"></a>
+ <div>
+ <pre>libraryDependencies += "org.apache.phoenix" % "phoenix-site" %
"2.0.0-SNAPSHOT"</pre>
+ </div>
+ </section>
+ <section>
+ <h3 id="Leiningen">Leiningen</h3><a name="Leiningen"></a>
+ <div>
+ <pre>[org.apache.phoenix/phoenix-site "2.0.0-SNAPSHOT"]</pre>
+ </div>
</section>
</section>
</main>
@@ -733,7 +772,7 @@ Reference
<div class="row">
<div class="col-md-12">
<p class="copyright">Copyright ©
-2025
+2026
<a href="http://www.apache.org";>Apache Software Foundation</a>
diff --git a/output/language/datatypes.html b/output/language/datatypes.html
index ea0e4d11..95cdbdf0 100644
--- a/output/language/datatypes.html
+++ b/output/language/datatypes.html
@@ -1298,7 +1298,7 @@ Reference
<div class="row">
<div class="col-md-12">
<p class="copyright">Copyright ©
-2025
+2026
<a href="http://www.apache.org";>Apache Software Foundation</a>
diff --git a/output/language/functions.html b/output/language/functions.html
index 07789ff0..1cd12375 100644
--- a/output/language/functions.html
+++ b/output/language/functions.html
@@ -2627,7 +2627,7 @@ Reference
<div class="row">
<div class="col-md-12">
<p class="copyright">Copyright ©
-2025
+2026
<a href="http://www.apache.org";>Apache Software Foundation</a>
diff --git a/output/language/index.html b/output/language/index.html
index 8ff0b2e0..278813e9 100644
--- a/output/language/index.html
+++ b/output/language/index.html
@@ -2397,7 +2397,7 @@ Reference
<div class="row">
<div class="col-md-12">
<p class="copyright">Copyright ©
-2025
+2026
<a href="http://www.apache.org";>Apache Software Foundation</a>
diff --git a/output/licenses.html b/output/licenses.html
index a1336ae9..05d739f5 100644
--- a/output/licenses.html
+++ b/output/licenses.html
@@ -162,18 +162,18 @@ Generated by Apache Maven Doxia
</div>
<main class="col-xs-12 col-sm-12 col-md-12 col-lg-12 col-xl-8"
role="main">
<section>
- <a name="Overview"></a>
<div class="page-header">
<h2 id="Overview">Overview</h2>
- </div>
+ </div><a name="Overview"></a>
<p>Typically the licenses listed for the project are that of the project
itself, and not of dependencies.</p>
</section>
<section>
- <a name="Project_Licenses"></a>
- <h2 id="Project_Licenses">Project Licenses</h2>
+ <h2 id="Project_Licenses">Project Licenses</h2><a name="Project_Licenses"></a>
<section>
- <a name="The_Apache_Software_License_Version_2.0"></a>
- <h3 id="The_Apache_Software_License.2C_Version_2.0">The Apache Software
License, Version 2.0</h3>
+ <h3 id="The_Apache_Software_License.2C_Version_2.0">The Apache Software
License, Version 2.0</h3><a
name="The_Apache_Software_License.2C_Version_2.0"></a>
+ <div>
+ <pre>-</pre>
+ </div>
</section>
</section>
</main>
@@ -738,7 +738,7 @@ Reference
<div class="row">
<div class="col-md-12">
<p class="copyright">Copyright ©
-2025
+2026
<a href="http://www.apache.org";>Apache Software Foundation</a>
diff --git a/output/plugin-management.html b/output/plugin-management.html
index 3b0de226..a9a538e3 100644
--- a/output/plugin-management.html
+++ b/output/plugin-management.html
@@ -161,10 +161,10 @@ Generated by Apache Maven Doxia
<div class="d-xs-none d-sm-none d-md-none d-lg-block col-lg-2">
</div>
<main class="col-xs-12 col-sm-12 col-md-12 col-lg-12 col-xl-8"
role="main">
- <section><a name="Project_Plugin_Management"></a>
+ <section>
<div class="page-header">
<h2 id="Project_Plugin_Management">Project Plugin Management</h2>
- </div>
+ </div><a name="Project_Plugin_Management"></a>
<table border="0" class="bodyTable table table-striped table-hover">
<thead>
<tr class="a">
@@ -175,22 +175,27 @@ Generated by Apache Maven Doxia
</thead>
<tbody>
<tr class="b">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/plugins/maven-antrun-plugin/";>maven-antrun-plugin</a></td>
<td>1.3</td>
</tr>
<tr class="a">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/plugins/maven-assembly-plugin/";>maven-assembly-plugin</a></td>
<td>2.2-beta-5</td>
</tr>
<tr class="b">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/plugins/maven-dependency-plugin/";>maven-dependency-plugin</a></td>
<td>2.8</td>
</tr>
<tr class="a">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
+ <td><a class="externalLink"
href="https://maven.apache.org/plugins/maven-project-info-reports-plugin/";>maven-project-info-reports-plugin</a></td>
+ <td>3.6.2</td>
+ </tr>
+ <tr class="b">
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/maven-release/maven-release-plugin/";>maven-release-plugin</a></td>
<td>2.5.3</td>
</tr>
@@ -759,7 +764,7 @@ Reference
<div class="row">
<div class="col-md-12">
<p class="copyright">Copyright ©
-2025
+2026
<a href="http://www.apache.org";>Apache Software Foundation</a>
diff --git a/output/plugins.html b/output/plugins.html
index d9fa92ab..fa99d987 100644
--- a/output/plugins.html
+++ b/output/plugins.html
@@ -161,10 +161,10 @@ Generated by Apache Maven Doxia
<div class="d-xs-none d-sm-none d-md-none d-lg-block col-lg-2">
</div>
<main class="col-xs-12 col-sm-12 col-md-12 col-lg-12 col-xl-8"
role="main">
- <section><a name="Project_Build_Plugins"></a>
+ <section>
<div class="page-header">
<h2 id="Project_Build_Plugins">Project Build Plugins</h2>
- </div>
+ </div><a name="Project_Build_Plugins"></a>
<table border="0" class="bodyTable table table-striped table-hover">
<thead>
<tr class="a">
@@ -175,60 +175,60 @@ Generated by Apache Maven Doxia
</thead>
<tbody>
<tr class="b">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/plugins/maven-clean-plugin/";>maven-clean-plugin</a></td>
<td>2.5</td>
</tr>
<tr class="a">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/plugins/maven-compiler-plugin/";>maven-compiler-plugin</a></td>
<td>3.1</td>
</tr>
<tr class="b">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/plugins/maven-dependency-plugin/";>maven-dependency-plugin</a></td>
<td>2.8</td>
</tr>
<tr class="a">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/plugins/maven-deploy-plugin/";>maven-deploy-plugin</a></td>
<td>2.7</td>
</tr>
<tr class="b">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/plugins/maven-install-plugin/";>maven-install-plugin</a></td>
<td>2.4</td>
</tr>
<tr class="a">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/plugins/maven-jar-plugin/";>maven-jar-plugin</a></td>
<td>2.4</td>
</tr>
<tr class="b">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/plugins/maven-resources-plugin/";>maven-resources-plugin</a></td>
<td>2.6</td>
</tr>
<tr class="a">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="https://maven.apache.org/plugins/maven-site-plugin/";>maven-site-plugin</a></td>
<td>3.12.1</td>
</tr>
<tr class="b">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="http://maven.apache.org/surefire/maven-surefire-plugin";>maven-surefire-plugin</a></td>
<td>2.12.4</td>
</tr>
<tr class="a">
- <td>org.codehaus.mojo</td>
+ <td align="left">org.codehaus.mojo</td>
<td><a class="externalLink"
href="https://www.mojohaus.org/exec-maven-plugin";>exec-maven-plugin</a></td>
<td>3.5.0</td>
</tr>
</tbody>
</table>
</section>
-<section><a name="Project_Report_Plugins"></a>
- <h2 id="Project_Report_Plugins">Project Report Plugins</h2>
+<section>
+ <h2 id="Project_Report_Plugins">Project Report Plugins</h2><a
name="Project_Report_Plugins"></a>
<table border="0" class="bodyTable table table-striped table-hover">
<thead>
<tr class="a">
@@ -239,9 +239,9 @@ Generated by Apache Maven Doxia
</thead>
<tbody>
<tr class="b">
- <td>org.apache.maven.plugins</td>
+ <td align="left">org.apache.maven.plugins</td>
<td><a class="externalLink"
href="https://maven.apache.org/plugins/maven-project-info-reports-plugin/";>maven-project-info-reports-plugin</a></td>
- <td>3.9.0</td>
+ <td>3.6.2</td>
</tr>
</tbody>
</table>
@@ -808,7 +808,7 @@ Reference
<div class="row">
<div class="col-md-12">
<p class="copyright">Copyright ©
-2025
+2026
<a href="http://www.apache.org";>Apache Software Foundation</a>
diff --git a/output/project-info.html b/output/project-info.html
index 2a0a9393..e1ea1b5f 100644
--- a/output/project-info.html
+++ b/output/project-info.html
@@ -766,7 +766,7 @@ Reference
<div class="row">
<div class="col-md-12">
<p class="copyright">Copyright ©
-2025
+2026
<a href="http://www.apache.org";>Apache Software Foundation</a>
diff --git a/output/summary.html b/output/summary.html
index fba9c0db..d9c20362 100644
--- a/output/summary.html
+++ b/output/summary.html
@@ -161,12 +161,12 @@ Generated by Apache Maven Doxia
<div class="d-xs-none d-sm-none d-md-none d-lg-block col-lg-2">
</div>
<main class="col-xs-12 col-sm-12 col-md-12 col-lg-12 col-xl-8"
role="main">
- <section><a name="Project_Summary"></a>
+ <section>
<div class="page-header">
<h2 id="Project_Summary">Project Summary</h2>
- </div>
- <section><a name="Project_Information"></a>
- <h3 id="Project_Information">Project Information</h3>
+ </div><a name="Project_Summary"></a>
+ <section>
+ <h3 id="Project_Information">Project Information</h3><a
name="Project_Information"></a>
<table border="0" class="bodyTable table table-striped table-hover">
<thead>
<tr class="a">
@@ -176,22 +176,22 @@ Generated by Apache Maven Doxia
</thead>
<tbody>
<tr class="b">
- <td>Name</td>
+ <td align="left">Name</td>
<td>Phoenix</td>
</tr>
<tr class="a">
- <td>Description</td>
+ <td align="left">Description</td>
<td>Phoenix site</td>
</tr>
<tr class="b">
- <td>Homepage</td>
+ <td align="left">Homepage</td>
<td><a class="externalLink"
href="http://phoenix.apache.org/";>http://phoenix.apache.org/</a></td>
</tr>
</tbody>
</table>
</section>
- <section><a name="Project_Organization"></a>
- <h3 id="Project_Organization">Project Organization</h3>
+ <section>
+ <h3 id="Project_Organization">Project Organization</h3><a
name="Project_Organization"></a>
<table border="0" class="bodyTable table table-striped table-hover">
<thead>
<tr class="a">
@@ -201,18 +201,18 @@ Generated by Apache Maven Doxia
</thead>
<tbody>
<tr class="b">
- <td>Name</td>
+ <td align="left">Name</td>
<td>Apache Software Foundation</td>
</tr>
<tr class="a">
- <td>URL</td>
+ <td align="left">URL</td>
<td><a class="externalLink"
href="http://www.apache.org";>http://www.apache.org</a></td>
</tr>
</tbody>
</table>
</section>
- <section><a name="Build_Information"></a>
- <h3 id="Build_Information">Build Information</h3>
+ <section>
+ <h3 id="Build_Information">Build Information</h3><a
name="Build_Information"></a>
<table border="0" class="bodyTable table table-striped table-hover">
<thead>
<tr class="a">
@@ -222,23 +222,23 @@ Generated by Apache Maven Doxia
</thead>
<tbody>
<tr class="b">
- <td>GroupId</td>
+ <td align="left">GroupId</td>
<td>org.apache.phoenix</td>
</tr>
<tr class="a">
- <td>ArtifactId</td>
+ <td align="left">ArtifactId</td>
<td>phoenix-site</td>
</tr>
<tr class="b">
- <td>Version</td>
+ <td align="left">Version</td>
<td>2.0.0-SNAPSHOT</td>
</tr>
<tr class="a">
- <td>Type</td>
+ <td align="left">Type</td>
<td>jar</td>
</tr>
<tr class="b">
- <td>Java Version</td>
+ <td align="left">Java Version</td>
<td>-</td>
</tr>
</tbody>
@@ -807,7 +807,7 @@ Reference
<div class="row">
<div class="col-md-12">
<p class="copyright">Copyright ©
-2025
+2026
<a href="http://www.apache.org";>Apache Software Foundation</a>
diff --git a/site/source/pom.xml b/site/source/pom.xml
index ba37445e..93658646 100644
--- a/site/source/pom.xml
+++ b/site/source/pom.xml
@@ -24,6 +24,15 @@
<build>
<directory>${project.basedir}/t1</directory>
+ <pluginManagement>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <version>3.6.2</version>
+ </plugin>
+ </plugins>
+ </pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
diff --git a/site/source/src/site/markdown/building_website.md
b/site/source/src/site/markdown/building_website.md
index 0e9e1518..da77834d 100644
--- a/site/source/src/site/markdown/building_website.md
+++ b/site/source/src/site/markdown/building_website.md
@@ -10,13 +10,14 @@ The Website build script has severely bit-rotted see
[PHOENIX-6867](https://issu
1. Make a local copy of source markdown files and html web pages
```
- $ svn checkout https://svn.apache.org/repos/asf/phoenix
+ $ git clone [email protected]:apache/phoenix-site.git
```
2. Edit/Add source markdown files in `site/source/src/site/markdown` directory.
2. Edit `phoenix-docs/src/docsrc/help/phoenix.csv` to update Reference pages,
adding any missing new words to
`phoenix-docs/src/tools/org/h2/build/doc/dictionary.txt`.
-3. Run `build.sh` located at root to generate/update html web pages in
`site/publish` directory
-4. `svn commit` source markdown files and html web pages
+3. Run `build.sh` located at root to generate/update html web pages in
`output` directory
+4. `git commit` source markdown files and html web pages then `git commit` and
`git push`
+5. Create a pull request in GitHub for the [mirror of the Phoenix Site Git
repository](https://github.com/apache/phoenix-site). Similarly to the GitHub
workflow mentioned in the [contributing](contributing.html) page.
# Local Testing During Development
@@ -25,7 +26,7 @@ The site uses protocol-relative URLs for included assets to
support `http` as we
For best results when testing locally, spin up a simple Python web server
after generating the site.
```
-cd site/publish
+cd output
python -m SimpleHTTPServer 8000
```
@@ -35,5 +36,5 @@ NOTE: If working with python3, use below command to spin up
a simple Python web
python3 -m http.server 8000
```
-Now you can access the website at `http://localhost:8000/` and your changes
are available with a page refresh.
+Now you can access the website at
[http://localhost:8000](http://localhost:8000) and your changes are available
with a page refresh.
