You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@struts.apache.org by rg...@apache.org on 2020/04/13 08:03:09 UTC
[struts-site] branch master updated (02a1379 -> 215bacb)
This is an automated email from the ASF dual-hosted git repository.
rgielen pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/struts-site.git.
from 02a1379 Correct link to Spring Security - WW-5059
new 1865c13 Adds HOWTO update the website
new 73090c5 Adds info about buildbot
new 9e5caff Fixes md formatting
new 215bacb Refer to update website documentation in README
The 4 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.
Summary of changes:
.project | 17 ++++++++++++
.settings/org.eclipse.core.resources.prefs | 2 ++
.settings/org.eclipse.m2e.core.prefs | 4 +++
README.md | 4 ++-
source/_includes/header.html | 1 +
source/updating-website.md | 43 ++++++++++++++++++++++++++++++
6 files changed, 70 insertions(+), 1 deletion(-)
create mode 100644 .project
create mode 100644 .settings/org.eclipse.core.resources.prefs
create mode 100644 .settings/org.eclipse.m2e.core.prefs
create mode 100644 source/updating-website.md
[struts-site] 04/04: Refer to update website documentation in README
Posted by rg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rgielen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/struts-site.git
commit 215bacb8d7eae334560863e75acbacbab8b9521f
Author: Rene Gielen <rg...@apache.org>
AuthorDate: Mon Apr 13 09:56:34 2020 +0200
Refer to update website documentation in README
---
.project | 17 +++++++++++++++++
.settings/org.eclipse.core.resources.prefs | 2 ++
.settings/org.eclipse.m2e.core.prefs | 4 ++++
README.md | 4 +++-
4 files changed, 26 insertions(+), 1 deletion(-)
diff --git a/.project b/.project
new file mode 100644
index 0000000..7487c85
--- /dev/null
+++ b/.project
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>struts2-site</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ <buildCommand>
+ <name>org.eclipse.m2e.core.maven2Builder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ </buildSpec>
+ <natures>
+ <nature>org.eclipse.m2e.core.maven2Nature</nature>
+ </natures>
+</projectDescription>
diff --git a/.settings/org.eclipse.core.resources.prefs b/.settings/org.eclipse.core.resources.prefs
new file mode 100644
index 0000000..99f26c0
--- /dev/null
+++ b/.settings/org.eclipse.core.resources.prefs
@@ -0,0 +1,2 @@
+eclipse.preferences.version=1
+encoding/<project>=UTF-8
diff --git a/.settings/org.eclipse.m2e.core.prefs b/.settings/org.eclipse.m2e.core.prefs
new file mode 100644
index 0000000..f897a7f
--- /dev/null
+++ b/.settings/org.eclipse.m2e.core.prefs
@@ -0,0 +1,4 @@
+activeProfiles=
+eclipse.preferences.version=1
+resolveWorkspaceProjects=true
+version=1
diff --git a/README.md b/README.md
index c57179e..70cf0da 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
+# Apache Struts Website
+
This project is used to update the main Apache Struts website http://struts.apache.org/
-Changes are [automatically](https://builds.apache.org/view/S-Z/view/Struts/job/Struts-site/) pushed online.
+See the [update website documentation](source/updating-website.md) on how to push changes online.
However as ASF is using aggressive caching, for a while one still may need to forcely reload the page (<kbd>CMD+R</kbd> or <kbd>Shift+F5</kbd>) after changes.
Site is generated by Jekyll and uses pure html either markdown format.
[struts-site] 02/04: Adds info about buildbot
Posted by rg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rgielen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/struts-site.git
commit 73090c50ee7e9e6816398499d922d97ee3a6775b
Author: Lukasz Lenart <lu...@apache.org>
AuthorDate: Sat Apr 11 19:03:18 2020 +0200
Adds info about buildbot
---
source/updating-website.md | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/source/updating-website.md b/source/updating-website.md
index f69f4d6..620714f 100644
--- a/source/updating-website.md
+++ b/source/updating-website.md
@@ -22,6 +22,11 @@ We are using Jekyll and mix of Markdown pages with raw Html pages, where Markdow
> WARN: do not manually change the `asf-site` or `ast-staging` branches, they will be automatically updated
> by CI server.
+The whole build of the website is orchestrated by [.asf.yaml](http://s.apache.org/asfyaml), please refer to the docs
+for more details. The main build of the website is performed by [a buildbot job](https://ci2.apache.org/#/builders/7),
+the staging site is build and deployed by [a Jenkins job](https://builds.apache.org/view/S-Z/view/Struts/job/Struts-staged-site/)
+- buildbot doesn't support staging site deployment yet.
+
## 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
[struts-site] 03/04: Fixes md formatting
Posted by rg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rgielen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/struts-site.git
commit 9e5caffa4b3e8e5768c594588cb6cd14a05c2c44
Author: Lukasz Lenart <lu...@apache.org>
AuthorDate: Sat Apr 11 19:05:42 2020 +0200
Fixes md formatting
---
source/updating-website.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/source/updating-website.md b/source/updating-website.md
index 620714f..d782c79 100644
--- a/source/updating-website.md
+++ b/source/updating-website.md
@@ -20,12 +20,12 @@ 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.
+> by a CI server.
The whole build of the website is orchestrated by [.asf.yaml](http://s.apache.org/asfyaml), please refer to the docs
for more details. The main build of the website is performed by [a buildbot job](https://ci2.apache.org/#/builders/7),
-the staging site is build and deployed by [a Jenkins job](https://builds.apache.org/view/S-Z/view/Struts/job/Struts-staged-site/)
-- buildbot doesn't support staging site deployment yet.
+the staging site is build and deployed by
+[a Jenkins job](https://builds.apache.org/view/S-Z/view/Struts/job/Struts-staged-site/) - buildbot doesn't support staging site deployment yet.
## Applying a change
[struts-site] 01/04: Adds HOWTO update the website
Posted by rg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
rgielen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/struts-site.git
commit 1865c13bea57c6f26c464869dfbc27bbffa0ebfd
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