Author: mseidel
Date: Tue Feb 5 12:44:32 2019
New Revision: 1853001
URL: http://svn.apache.org/viewvc?rev=1853001&view=rev
Log:
Removed whitespace, changed links to https
Modified:
openoffice/site/trunk/content/orientation/intro-doc.mdtext
Modified: openoffice/site/trunk/content/orientation/intro-doc.mdtext
URL:
http://svn.apache.org/viewvc/openoffice/site/trunk/content/orientation/intro-doc.mdtext?rev=1853001&r1=1853000&r2=1853001&view=diff
==============================================================================
--- openoffice/site/trunk/content/orientation/intro-doc.mdtext (original)
+++ openoffice/site/trunk/content/orientation/intro-doc.mdtext Tue Feb 5
12:44:32 2019
@@ -26,21 +26,21 @@ Your first task is to subscribe to our D
Then you can introduce yourself by [sending an email to the
list](mailto:[email protected]?subject=New Doc Volunteer). We'd love
to hear who you are, where you are from, what your background is, etc. Also as
you work through the items on this page, if you have questions or problems,
please feel free to ask for help by sending a note to this same list.
-Note: In parallel with the Doc-specific items on this page, you may want to
also review the [Level 1 and Level 2 Orientation
Modules](http://openoffice.apache.org/orientation/index.html). They have useful
background information on The Apache Way, mailing list etiquette, decision
making in the project, etc. A quick review is a good idea, especially if you
are new to working in Apache-style open source projects.
+Note: In parallel with the Doc-specific items on this page, you may want to
also review the [Level 1 and Level 2 Orientation
Modules](https://openoffice.apache.org/orientation/index.html). They have
useful background information on The Apache Way, mailing list etiquette,
decision making in the project, etc. A quick review is a good idea, especially
if you are new to working in Apache-style open source projects.
Now with the introductions out of the way, let's get started!
##The Big Picture
-As a popular end-user facing product, Apache OpenOffice is used by millions of
people around the world, with a wide range of skills and backgrounds. Some have
been using OpenOffice for a decade. Others are just moving over from Microsoft
Office. Some are very familiar with computers and their operating systems.
Others may be using a computer for the first time. Some are doing just basic
editing. Others are "power users" and are creating complex applications built
on top of OpenOffice.
+As a popular end-user facing product, Apache OpenOffice is used by millions of
people around the world, with a wide range of skills and backgrounds. Some have
been using OpenOffice for decades. Others are just moving over from Microsoft
Office. Some are very familiar with computers and their operating systems.
Others may be using a computer for the first time. Some are doing just basic
editing. Others are "power users" and are creating complex applications built
on top of OpenOffice.
When users have a question, when they get stuck, there are a wide range of
options for them:
- - They might ask a friend for help
- - They might search Google for help
- - They might press F1 in the application and look for help
- - They might post a question to our [community support
forum](http://forum.openoffice.org)
- - They might go to the [OpenOffice.org website](http://www.openoffice.org)
and look for a solution there
+ - They might ask a friend for help
+ - They might search Google for help
+ - They might press F1 in the application and look for help
+ - They might post a question to our [community support
forum](https://forum.openoffice.org/)
+ - They might go to the [OpenOffice.org
website](https://www.openoffice.org) and look for a solution there
The documentation we write aids both the end-users as well as those who
support the end users. We aim to provide authoritative, up-to-date material for
Apache OpenOffice, and to aid users of all skill levels. If we do our tasks
well, users are more satisfied and more productive.
@@ -48,9 +48,9 @@ The documentation we write aids both the
We maintain documentation in a variety of forms:
- - Built-in help files that are included in the product installs. These are
context-sensitive help files that you get when you press "F1" in an OpenOffice
application.
- - User Guides that are available on the website. These include a mixture of
overview and task-specific topics.
- - Special topics, such as migration guides, scripting cookbooks, etc.
+ - Built-in help files that are included in the product installs. These
are context-sensitive help files that you get when you press "F1" in an
OpenOffice application.
+ - User Guides that are available on the website. These include a
mixture of overview and task-specific topics.
+ - Special topics, such as migration guides, scripting cookbooks, etc.
All OpenOffice documentation is housed on the [OpenOffice
wiki](https://wiki.openoffice.org/wiki/Documentation) for ease of maintenance
by volunteers with the exception of the help files which are integrated with
the OpenOffice product itself.
@@ -58,10 +58,10 @@ All OpenOffice documentation is housed o
In our documentation work we need to be aware of the following goals and
constraints:
- - Only around 1/3 of OpenOffice users speak English as their native
language. This is true also of the volunteers working on documentation. So in
our list conversations, and in our documentation, we should aim for good,
simple English prose, avoiding regional idioms and jargon. By convention we're
adopting U.S. English spelling for the documentation. So we should plan for the
documentation we write to be translated at some point.
- - We should also write the documentation so it can be translated into other
languages. This means we need to be careful about how we mix text and graphics
together in any diagrams.
- - We use the [Apache License
2.0](http://www.apache.org/licenses/LICENSE-2.0.html) for all project
deliverables. This "permissive" open source license ensures that everyone has
the ability to adapt and reuse the documentation that we create. But it also
means that we need to be careful about what other 3rd party material we use in
our documentation. Until you are familiar with the Apache rules for using 3rd
party material into an Apache product, you should start a discussion on the
mailing list for any 3rd party material you want to reuse. This includes
material from the legacy OpenOffice.org project as well, since some of that was
under a different license.
- - We're aiming to provide as much content as possible in the form of MWiki
pages. These are easy for users to access, from any device. Also, since they
are indexed by search engines they will be easy to find for the users who like
to resolve issues by searching Google for solutions.
+ - Only around 1/3 of OpenOffice users speak English as their native
language. This is true also of the volunteers working on documentation. So in
our list conversations, and in our documentation, we should aim for good,
simple English prose, avoiding regional idioms and jargon. By convention we're
adopting U.S. English spelling for the documentation. So we should plan for the
documentation we write to be translated at some point.
+ - We should also write the documentation so it can be translated into
other languages. This means we need to be careful about how we mix text and
graphics together in any diagrams.
+ - We use the [Apache License
2.0](https://www.apache.org/licenses/LICENSE-2.0.html) for all project
deliverables. This "permissive" open source license ensures that everyone has
the ability to adapt and reuse the documentation that we create. But it also
means that we need to be careful about what other 3rd party material we use in
our documentation. Until you are familiar with the Apache rules for using 3rd
party material into an Apache product, you should start a discussion on the
mailing list for any 3rd party material you want to reuse. This includes
material from the legacy OpenOffice.org project as well, since some of that was
under a different license.
+ - We're aiming to provide as much content as possible in the form of
MWiki pages. These are easy for users to access, from any device. Also, since
they are indexed by search engines they will be easy to find for the users who
like to resolve issues by searching Google for solutions.
##Volunteers are Welcome
@@ -71,20 +71,20 @@ For some specialized areas skills in gra
Volunteers on the Documentation Team work on a variety of tasks, including:
- - Authoring draft documentation on a specific area of the OpenOffice product.
- - Reviewing draft documentation for technical correctness, e.g., repeating
the steps described in a task and verifying that they are complete and no steps
are missing.
- - Editing draft documentation for clarity and style.
- - Preparing screenshots, diagrams and artwork for covers.
- - Developing tools and scripts to aid in repetitive tasks, such as document
format conversions.
-
+ - Authoring draft documentation on a specific area of the OpenOffice
product.
+ - Reviewing draft documentation for technical correctness, e.g.,
repeating the steps described in a task and verifying that they are complete
and no steps are missing.
+ - Editing draft documentation for clarity and style.
+ - Preparing screenshots, diagrams and artwork for covers.
+ - Developing tools and scripts to aid in repetitive tasks, such as
document format conversions.
+
##Getting Started
-
+
The Documentation Team is the easiest one to get started with. There are just
a few basic steps:
-1. Subscribe to our Documentation mailing list by sending an email to
[[email protected]](mailto:[email protected]).
+1. Subscribe to our Documentation mailing list by sending an email to
[[email protected]](mailto:[email protected]).
1. Sign up for an account on our MWiki by sending an e-mail with your
preferred user name and e-mail address to the [Documentation mailing
list](mailto:[email protected]?subject=Requesting MWiki Account)
-1. Sign up for an account on [our
CWiki](https://cwiki.apache.org/confluence/display/OOOUSERS/Wiki+Home) (Why do
we have two wikis? It is a long story...)**Note:** **After creation the
account must be whitelisted by sending a request with the account name to the
[Documentation mailing
list](mailto:[email protected]?subject=Whitelist CWiki Account)**
-1. Add your name to our [Directory of
Volunteers](https://cwiki.apache.org/confluence/display/OOOUSERS/Directory+of+Volunteers)
and
+1. Sign up for an account on [our
CWiki](https://cwiki.apache.org/confluence/display/OOOUSERS/Wiki+Home) (Why do
we have two wikis? It is a long story...)**Note:** **After creation the account
must be whitelisted by sending a request with the account name to the
[Documentation mailing
list](mailto:[email protected]?subject=Whitelist CWiki Account)**
+1. Add your name to our [Directory of
Volunteers](https://cwiki.apache.org/confluence/display/OOOUSERS/Directory+of+Volunteers)
and
[Documentation
Volunteers](https://cwiki.apache.org/confluence/display/OOOUSERS/Documentation+Volunteers)
pages.
1. Send an email to the [Documentation mailing
list](mailto:[email protected]?subject=New Doc Volunteer) and
introduce yourself.
@@ -92,4 +92,4 @@ We can then bring you up to speed on wha
## Module Completion
-Once you have completed this module, go to our our [Directory of
Volunteers](https://cwiki.apache.org/confluence/display/OOOUSERS/Directory+of+Volunteers)
wiki page and add or update your information. Congratulations! Please send a
note to
[[email protected]](mailto:[email protected]?subject=Completed
Introduction to Documentation) so we know.
+Once you have completed this Module, go to our our [Directory of
Volunteers](https://cwiki.apache.org/confluence/display/OOOUSERS/Directory+of+Volunteers)
wiki page and add or update your information. Congratulations! Please send a
note to
[[email protected]](mailto:[email protected]?subject=Completed
Introduction to Documentation) so we know.
