You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openoffice.apache.org by wa...@apache.org on 2020/11/05 19:33:08 UTC

[openoffice-org] branch main updated: Update 2 of the README files

This is an automated email from the ASF dual-hosted git repository.

wave pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/openoffice-org.git


The following commit(s) were added to refs/heads/main by this push:
     new 72c3f5d  Update 2 of the README files
72c3f5d is described below

commit 72c3f5daa18040f85edbab75938b0dfa949d6b62
Author: Dave Fisher <da...@davefisher.tech>
AuthorDate: Thu Nov 5 11:32:56 2020 -0800

    Update 2 of the README files
---
 README.md       | 11 ++++++-----
 tools/README.md | 33 ++++++++++++++++-----------------
 2 files changed, 22 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index ccf6aa7..c304739 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ This is the content and build scripts for https:/www.openoffice.org/
 
 ## Contributing to the website content
 
-You can fork from https://github.com/apache/incubator, test your changes as described below
+You can fork from https://github.com/apache/openoffice-org, test your changes as described below
 and raise a pull request.
 
 Use the [dev@openoffice.a.o](https://lists.apache.org/list.html?dev@openoffice.apache.org) mailing list to contact
@@ -23,7 +23,7 @@ Once the staged content is correct then the `asf-staging` branch's `content` fol
 using `copy_staging.sh` by the [OpenOffice-org-Publish-Site](https://ci-builds.apache.org/job/OpenOffice/job/OpenOffice-org-Publish-Site/)
 Jenkins job. This job will need to be started manually.
 
-Any build failures are reported to *[commits@openoffice.a.o](https://lists.apache.org/list.html?commits@openoffice.apache.org)*
+Any build failures are reported to [commits@openoffice.a.o](https://lists.apache.org/list.html?commits@openoffice.apache.org)
 mailing list.
 
 ## Quick updates to a single file
@@ -31,7 +31,7 @@ mailing list.
 Updating a single file should proceed as follows. I'll use the most commonly updated file (the weekly download numbers) as an example:
 
 - Navigate to the [`assets/stats` folder](https://github.com/apache/openoffice-org/tree/main/assets/stats)
-- Click on [`aoo-downloads.txt` file] and edit it.
+- Click on [`aoo-downloads.txt` file](https://github.com/apache/openoffice-org/blob/main/assets/stats/aoo-downloads.txt) and edit it.
 - Commit changes.
 - Wait for the [OpenOffice-org-Staging-Site-Build](https://ci-builds.apache.org/job/OpenOffice/job/OpenOffice-org-Staging-Site-Build/) to complete. This will take 5-6 minutes unless another build is using the server.
 - Check the [`Download Stats page`](https://openoffice-org.staged.apache.org/stats/downloads.html)
@@ -70,7 +70,7 @@ To test the site locally, use
 This builds the site, serves it locally at  http://localhost:8820/ and rebuilds the content fairly
 quickly if any changes are made.
 
-Note that serving the site through JBake does not properly include the SSI which means that branding, navigation, and footers will be missing. If you wish to set up an HTTPD server on your local you do that too.
+Note that serving the site through JBake does not properly include the SSI which means that branding, navigation, and footers will be missing. If you wish to set up an HTTPD server on your local you can do that too.
 
 Modify that script andd call `bake.sh`  with any of the [arguments you would pass to jbake](https://jbake.org/docs/2.6.4/#bake_command).
 
@@ -106,7 +106,8 @@ Every file in the assets tree is copied as is during baking.
 
     https://github.com/apache/openoffice-org/tree/main/assets
 
-Please do not add any `.exe` binaries. Files larger then 100MB are not allowed and over 50MB are not recommended. Only one file was too large to migrate.
+* Files larger than 100MB are not allowed and over 50MB are not recommended. Only one file in the CMS site was too large to migrate.
+* Please do not add any `.exe` binaries.
 
 ### Footer
 
diff --git a/tools/README.md b/tools/README.md
index 17fb28b..7c729c2 100644
--- a/tools/README.md
+++ b/tools/README.md
@@ -1,8 +1,6 @@
 # Migration from CMS to Github/JBake
 
-## Git Repository
-
-1. Clone the Git Repository
+## Clone the Git Repository
 
 ```
 cd ~/Development/openoffice
@@ -30,7 +28,7 @@ cd ~/Development/openoffice/ooo-sit.git/assets/
   These are copied to the site unmodified.
 
 
-1. Checkout Old SVN CMS version of site.
+## Checkout Old SVN CMS version of site.
 
 ```
 cd ~/Development/openoffice
@@ -38,7 +36,7 @@ rm -rf ooo-site
 svn co https://svn.apache.org/repos/asf/openoffice/ooo-site/trunk ooo-site
 ```
 
-1. Setup Environment variables.
+## Setup Environment variables.
 
 ```
 # location of CMS content
@@ -47,15 +45,16 @@ export SVNPATH="~/Development/openoffice/ooo-site/content"
 export GITPATH="~/Development/openoffice/ooo-site.git"
 ```
 
-1. List of Folders.
-   These won't be done in one session. Make the list and track what you've migrated.
+## List of Folders.
+
+These won't be done in one session. Make the list and track what you've migrated.
 
 ```
 cd ${SVNPATH}
 find . -type d -depth 1 -print | sed -e 's!./!!' | sort
 ```
 
-   You could compare with the git targets with:
+You could compare with the git targets with:
 
 ```
 cd ${GITPATH}/assets
@@ -64,16 +63,16 @@ cd ${GITPATH}/content
 find . -type d -depth 1 -print | sed -e 's!./!!' | sort
 ```
 
-1. Migration of a Folder.
+## Migration of a Folder.
 
 ```
 cd ${SVNPATH}
 ${GITPATH}/tools/migration2git.sh downloads
 ```
 
-   Some folders are larger than others. Pay attention to the running count.
+Some folders are larger than others. Pay attention to the running count.
 
-1. Periodic Builds
+## Periodic Builds
 
 ```
 cd ${GITPATH}
@@ -83,11 +82,11 @@ cd ${GITPATH}
 # on asf-site branch
 ```
 
-   This is done so that the commits in asf-staging and asf-site do not get too large.
+This is done so that the commits in asf-staging and asf-site do not get too large.
 
-## Tool Scripts
+# Tool Scripts
 
-1. tools/commit2git.sh ${1} ${2} ${3}
+1. `tools/commit2git.sh ${1} ${2} ${3}`
 
 ```
 # ${1} Category 'assets','content'
@@ -98,7 +97,7 @@ git add ${1}/${2}
 git commit -m 'Migration of ${2} ${3}'
 ```
 
-2. tools/convert2md.sh ${1} ${2}
+2. `tools/convert2md.sh ${1} ${2}`
 
 ```
 # ${1} Template type 'brand','navigator','page'
@@ -107,7 +106,7 @@ echo 'type=${1}' > ${GITPATH}/content/${2}
 nawk -f ${GITPATH}/tools/convert2md.awk ${2} >> ${GITPATH}/content/${2}
 ```
 
-3. tools/migration2git.sh ${1}
+3. `tools/migration2git.sh ${1}`
 
 ```
 # ${1} Site folder to migrate
@@ -154,7 +153,7 @@ echo 'Push to Gitbox'
 ${GITPATH}/tools/push2git.sh
 ```
 
-4. tools/push2git.sh
+4. `tools/push2git.sh`
 
 ```
 cd ${GITPATH}