[struts-site] branch contributors-guide updated: Adds missing pages
This is an automated email from the ASF dual-hosted git repository.
lukaszlenart pushed a commit to branch contributors-guide
in repository https://gitbox.apache.org/repos/asf/struts-site.git
The following commit(s) were added to refs/heads/contributors-guide by this
push:
new 026ce17 Adds missing pages
026ce17 is described below
commit 026ce17b60b56cde04ea32f96df24d46c7efb0ed
Author: Lukasz Lenart
AuthorDate: Thu Oct 1 20:50:45 2020 +0200
Adds missing pages
---
source/contributors/documentation-style-guide.md | 214 +++
source/contributors/editing-the-documentation.md | 51 ++
source/contributors/index.md | 10 +-
3 files changed, 267 insertions(+), 8 deletions(-)
diff --git a/source/contributors/documentation-style-guide.md
b/source/contributors/documentation-style-guide.md
new file mode 100644
index 000..f525854
--- /dev/null
+++ b/source/contributors/documentation-style-guide.md
@@ -0,0 +1,214 @@
+---
+layout: default
+title: Documentation Style Guide
+parent:
+ title: Contributors Guide
+ url: index.html
+---
+
+# Documentation Style Guide
+{:.no_toc}
+
+* Will be replaced with the ToC, excluding a header
+{:toc}
+
+It's well-known that a consistent user interface is easier to use. Consistency
helps users focus on the task rather
+than the user interface. Likewise, a consistent documentation style helps
users focus on the information, rather
+than the formatting.
+
+A related goal is to design the documentation so that it is easy to maintain,
so that it tends to remain internally
+consistent with the framework itself.
+
+## Do it now. Do it once. Do it well.
+
+Overall, there are three goals for the documentation system.
+
+- Say it all
+- Say it once
+- Say it well
+
+First, we want the documentation to be both complete and concise. This is job
one! The documentation should also be a quick
+but practical introduction to the framework, so newcomers can get started as
easily as possible. To keep people coming back,
+the documentation should also be a repository of the tips and tricks we use in
our own applications, so that people can find
+it here instead of asking over and over again on the list.
+
+Second, the documentation should be easy to maintain. Ideally, we should cover
the detail of each topic once, and draw
+as much detail from the source code and examples as possible (using the
_snippet macro_).
+
+Third, the documentation should be text-book quality; if not in the first
draft, then in the next. Don't hesitate
+to hack in a new page. Better that we have the page than we don't. (See Job
One!) But, as time allows, we should try
+to make each page the best that it can be. A great many people access the
documentation, and it's worth the effort
+to make the "documentation experience" productive and enjoyable.
+
+## Capitalization of common terms
+
+- Java
+- Javadoc
+- HTML
+- XML
+
+## General Punctuation and Grammar
+
+Good online resources for punctuation, grammar, and text style include
+
+- [Wikipedia Manual of
Style](https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style)
+
+In print, two excellent (and inexpensive!) resources are
+
+- [The Elements of
Style](https://www.amazon.com/exec/obidos/tg/detail/-/020530902X/apachesoftwar-20/)
+- [Associated Press
Stylebook](https://www.amazon.com/exec/obidos/tg/detail/-/0465004881/apachesoftwar-20/)
+
+Also excellent, but more expensive:
+
+- [Chicago Manual of Style](https://www.chicagomanualofstyle.org/)
+
+## Quick Tips
+
+- Use as few words as possible. Instead of "but there are some quirks about
it" try "but there are quirks".
+- If a list of items includes both a term and an explanation, consider using a
table instead of bullets.
+- Avoid using "This" by itself. Instead of "This lets us" try "This strategy
lets us".
+ - Ask yourself: "This what?"
+- References to other wiki pages can be unqualified. For example: "See ."
+
+## Don't be smurfy!
+
+A lot of API members use the term "action". We have
+
+- action extensions on pages,
+- action attributes in forms,
+- action elements in configuration files, and
+- Action Java classes, some of which may implement the
+- Action interface.
+
+Here are some terms that can be used to help clarify which action is which.
+
+- Use "the framework" or "Struts 2" to refer to the codebase as a whole,
including any frameworks we use internally, like OGNL.
+- Use "Action class" or "action handler" to refer to the Java class
incorporated by the action element.
+- Use "action mapping" to refer to the object created by the action element.
+
+## Page Save Comment
+
+Try to include a brief description of a change when saving a page. The
comments are included in the page's history.
+The comments are also included on the daily change report. In a group
environment, it's important to help each other follow along.
+
+## Parent Pages
+
+Use the Parent Page feature to create a hierarchy of pages. The parent pages
a
[struts-site] branch asf-staging updated: Updates stage by Jenkins
This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-staging
in repository https://gitbox.apache.org/repos/asf/struts-site.git
The following commit(s) were added to refs/heads/asf-staging by this push:
new 0a6517a Updates stage by Jenkins
0a6517a is described below
commit 0a6517a685f05e0cbc4b2bb317304ee0a5c7c5ae
Author: jenkins
AuthorDate: Thu Oct 1 18:52:46 2020 +
Updates stage by Jenkins
---
.../contributors/documentation-style-guide.html| 460 +
.../{index.html => editing-the-documentation.html} | 75 ++--
content/contributors/index.html| 12 +-
3 files changed, 499 insertions(+), 48 deletions(-)
diff --git a/content/contributors/documentation-style-guide.html
b/content/contributors/documentation-style-guide.html
new file mode 100644
index 000..258450c
--- /dev/null
+++ b/content/contributors/documentation-style-guide.html
@@ -0,0 +1,460 @@
+
+
+
+
+
+
+
+
+
+ Documentation Style Guide
+
+
+
+
+
+
+
+
+
+
+
+
+
+http://github.com/apache/struts"; class="github-ribbon">
+ https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa.png";
alt="Fork me on GitHub">
+
+
+
+
+
+
+
+
+Menu
+Toggle navigation
+
+
+
+
+
+
+
+
+
+
+Home
+
+
+Welcome
+Download
+Releases
+Announcements
+http://www.apache.org/licenses/";>License
+https://www.apache.org/foundation/thanks.html";>Thanks!
+https://www.apache.org/foundation/sponsorship.html";>Sponsorship
+
+
+
+
+Support
+
+
+User Mailing List
+https://issues.apache.org/jira/browse/WW";>Issue
Tracker
+Reporting Security Issues
+
+https://cwiki.apache.org/confluence/display/WW/Migration+Guide";>Version
Notes
+https://cwiki.apache.org/confluence/display/WW/Security+Bulletins";>Security
Bulletins
+
+Maven Project
Info
+Struts
Core Dependencies
+Plugin
Dependencies
+
+
+
+
+Documentation
+
+
+Birds Eye
+Key Technologies
+Kickstart FAQ
+https://cwiki.apache.org/confluence/display/WW/Home";>Wiki
+
+Getting Started
+Security Guide
+Core Developers Guide
+Tag Developers Guide
+Maven Archetypes
+Plugins
+Struts
Core API
+Tag
reference
+https://cwiki.apache.org/confluence/display/WW/FAQs";>FAQs
+http://cwiki.apache.org/S2PLUGINS/home.html";>Plugin registry
+
+
+
+
+Contributing
+
+
+You at Struts
+How to Help FAQ
+Development Lists
+Contributors Guide
+
+Submitting
patches
+Source Code and Builds
+Coding standards
+https://cwiki.apache.org/confluence/display/WW/Contributors+Guide";>Contributors
Guide
+
+Release
Guidelines
+PMC Charter
+Volunteers
+https://gitbox.apache.org/repos/asf?p=struts.git";>Source
Repository
+Updating the
website
+
+
+http://www.apache.org/";>
+
+
+
+
+
+
+
+
+
+
+https://github.com/apache/struts-site/edit/master/source/contributors/documentation-style-guide.md";
title="Edit this page on GitHub">Edit on GitHub
+
+<< back to
Contributors Guide
+
+Documentation Style
Guide
+
+
+ Do it now. Do it once. Do it
well.
+ Capitalization of common
terms
+ General Punctuation and
Grammar
+ Quick Tips
+ Don’t be
smurfy!
+ Page
Save Comment
+ Parent
Pages
+ Labels
+ Avoid skipping headers
+ More on Text Effects
+ Text Breaks
+ Lists
+ Images
+ Tables
+ Advanced Formatting
+ Change
Happens
+
+
+It’s well-known that a consistent user interface is easier to use.
Consistency helps users focus on the task rather
+than the user interface. Likewise, a consistent documentation style helps
users focus on the information, rather
+than the formatting.
+
+A related goal is to design the documentation so that it is easy to
maintain, so that it tends to remain internally
[struts-site] branch master updated: Polishes announcement about Struts 2.5.25
This is an automated email from the ASF dual-hosted git repository.
lukaszlenart pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/struts-site.git
The following commit(s) were added to refs/heads/master by this push:
new aecd260 Polishes announcement about Struts 2.5.25
aecd260 is described below
commit aecd2603790fedcdc629213fb5296861587a10a6
Author: Lukasz Lenart
AuthorDate: Fri Oct 2 08:53:58 2020 +0200
Polishes announcement about Struts 2.5.25
---
_config.yml| 3 +++
source/announce.md | 7 +--
2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/_config.yml b/_config.yml
index 7060655..21c951e 100644
--- a/_config.yml
+++ b/_config.yml
@@ -33,3 +33,6 @@ wiki_url: https://cwiki.apache.org/confluence/display/WW
# Archive site with all the versions
archive_url: https://archive.apache.org/dist/struts/
+
+# JIRA issue tracking
+jira_url: https://issues.apache.org/jira/projects/WW/
diff --git a/source/announce.md b/source/announce.md
index 94f2988..ee8f497 100644
--- a/source/announce.md
+++ b/source/announce.md
@@ -34,13 +34,16 @@ Below is a full list of all changes:
- Update multiple Struts 2.5.x libraries / Maven build plugin versions
- Upgrade OSGi to the latest version
+> Please read the [Version Notes]({{ site.wiki_url }}/Version+Notes+2.5.25) to
find more details about performed
+> bug fixes and improvements.
+
**All developers are strongly advised to perform this action.**
The 2.5.x series of the Apache Struts framework has a minimum requirement of
the following specification versions:
Servlet API 2.4, JSP API 2.0, and Java 7.
-Should any issues arise with your use of any version of the Struts framework,
please post your comments
-to the user list, and, if appropriate, file a tracking ticket.
+Should any issues arise with your use of any version of the Struts framework,
please post your comments to the user list,
+and, if appropriate, file [a tracking ticket]({{ site.jira_url }}).
You can download this version from our [download](download.cgi#struts-ga) page.
Buildbot success in on jekyll_websites
The Buildbot has detected a passing build on builder jekyll_websites while building struts. Full details are available at: https://ci2.apache.org/#builders/7/builds/206 Buildbot URL: https://ci2.apache.org/ Worker for this Build: bb_slave10_ubuntu Build Reason: Triggered jekyll auto-build via .asf.yaml by lukaszlenart Blamelist: asfinfra, commits@struts.apache.org Build succeeded! Sincerely, -The Buildbot
[struts-site] branch asf-site updated: Automatic Site Publish by Buildbot
This is an automated email from the ASF dual-hosted git repository. git-site-role pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/struts-site.git The following commit(s) were added to refs/heads/asf-site by this push: new f56ee92 Automatic Site Publish by Buildbot f56ee92 is described below commit f56ee927a693e408c9309ecb444f4cc22e1ef550 Author: buildbot AuthorDate: Fri Oct 2 06:54:51 2020 + Automatic Site Publish by Buildbot --- output/announce.html | 9 +++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/output/announce.html b/output/announce.html index 9874080..511eb0f 100644 --- a/output/announce.html +++ b/output/announce.html @@ -162,13 +162,18 @@ to maintaining applications over time. Upgrade OSGi to the latest version + + Please read the https://cwiki.apache.org/confluence/display/WW/Version+Notes+2.5.25";>Version Notes to find more details about performed +bug fixes and improvements. + + All developers are strongly advised to perform this action. The 2.5.x series of the Apache Struts framework has a minimum requirement of the following specification versions: Servlet API 2.4, JSP API 2.0, and Java 7. -Should any issues arise with your use of any version of the Struts framework, please post your comments -to the user list, and, if appropriate, file a tracking ticket. +Should any issues arise with your use of any version of the Struts framework, please post your comments to the user list, +and, if appropriate, file https://issues.apache.org/jira/projects/WW/";>a tracking ticket. You can download this version from our download page.
