You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@struts.apache.org by lu...@apache.org on 2020/04/11 16:56:19 UTC
[struts-site] branch updating-website created (now dc3d110)
This is an automated email from the ASF dual-hosted git repository.
lukaszlenart pushed a change to branch updating-website
in repository https://gitbox.apache.org/repos/asf/struts-site.git.
at dc3d110 Adds HOWTO update the website
This branch includes the following new commits:
new dc3d110 Adds HOWTO update the website
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[struts-site] 01/01: Adds HOWTO update the website
Posted by lu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
lukaszlenart pushed a commit to branch updating-website
in repository https://gitbox.apache.org/repos/asf/struts-site.git
commit dc3d11046df95079bca32c7311ebe37bad1aff98
Author: Lukasz Lenart <lu...@apache.org>
AuthorDate: Sat Apr 11 18:56:09 2020 +0200
Adds HOWTO update the website
---
source/_includes/header.html | 1 +
source/updating-website.md | 38 ++++++++++++++++++++++++++++++++++++++
2 files changed, 39 insertions(+)
diff --git a/source/_includes/header.html b/source/_includes/header.html
index 39e6bdf..53cb691 100644
--- a/source/_includes/header.html
+++ b/source/_includes/header.html
@@ -89,6 +89,7 @@
<li><a href="/bylaws.html">PMC Charter</a></li>
<li><a href="/volunteers.html">Volunteers</a></li>
<li><a href="https://gitbox.apache.org/repos/asf?p=struts.git">Source Repository</a></li>
+ <li><a href="/updating-website.html">Updating the website</a></li>
</ul>
</li>
<li class="apache"><a href="http://www.apache.org/"><img src="/img/apache.png"></a></li>
diff --git a/source/updating-website.md b/source/updating-website.md
new file mode 100644
index 0000000..f69f4d6
--- /dev/null
+++ b/source/updating-website.md
@@ -0,0 +1,38 @@
+---
+layout: default
+title: Updating the website
+---
+
+# Updating the website
+{:.no_toc}
+
+* Will be replaced with the ToC, excluding a header
+{:toc}
+
+## The setup
+
+The whole website is available in a dedicated Git [repository](https://gitbox.apache.org/repos/asf?p=struts-site.git),
+you can also use a Github [mirror](https://github.com/apache/struts-site).
+
+The `master` branch contains the current source code of the website, any changes should be applied to this branch,
+also any Pull Request should be opened against this branch as well.
+
+We are using Jekyll and mix of Markdown pages with raw Html pages, where Markdown is a preferred option.
+
+> WARN: do not manually change the `asf-site` or `ast-staging` branches, they will be automatically updated
+> by CI server.
+
+## Applying a change
+
+If you are a contributor, and the change is small you can push it directly to the `master` branch. In any other case
+please open a Pull Request. The Pull Request will be automatically build and deployed to the [staging site](https://struts.staged.apache.org/).
+
+You can then review your changes before applying them to the `master` branch.
+
+## Deploying JavaDocs
+
+There is a dedicated [Jenkins job](https://builds.apache.org/view/S-Z/view/Struts/job/Struts-site-javadocs/) which is
+used to update the JavaDocs based on the latest release. If you have a proper privileges you can start the job
+and provide a Git tag of the latest release, eg. `STRUTS_2_5_22`. Based on the tag Jenkins will generate a proper
+JavaDocs and deploy them directly into the website. You can verify them by using this [link](https://struts.staged.apache.org/maven/struts2-core/apidocs/index.html).
+
\ No newline at end of file