This is an automated email from the ASF dual-hosted git repository.
sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/whimsy.git
The following commit(s) were added to refs/heads/master by this push:
new 3adae0e7 improve documentation (#242)
3adae0e7 is described below
commit 3adae0e771ee0a8c1429978338d1a8783a1bf481
Author: Hervé Boutemy <[email protected]>
AuthorDate: Mon Jan 27 01:04:40 2025 +0100
improve documentation (#242)
---
DOCKER.md | 32 ++++++++++++++++----------------
tools/collate_minutes.rb | 2 +-
www/board/minutes/.gitignore | 2 +-
3 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/DOCKER.md b/DOCKER.md
index fa694c42..cd5009de 100644
--- a/DOCKER.md
+++ b/DOCKER.md
@@ -19,7 +19,7 @@ Prerequisites
-------------
You will need Docker, git, and subversion. And approximately 3 GB of
-disk space
+disk space.
Direct link to [docker for
macOS](https://download.docker.com/mac/stable/Docker.dmg) (this avoids the
@@ -38,7 +38,7 @@ used by the host machine matches the format used by the
container. Currently
macOS Catalina/Xcode provides svn 1.10.4 and the Dockerfile downloads the
latest 1.10 version (currently 1.10.6).
-Finally, a note on password stores. Inside ~/.subversion/config, you will see
+Finally, a note on password stores. Inside `~/.subversion/config`, you will
see
a list of available stores, which currently is `gnome-keyring`, `kwallet`,
`gpg-agent`, `keychain`, and `windows-cryptoapi`. The only ones that are
available to an Ubuntu container are ones marked as for "Unix-like systems".
@@ -61,18 +61,18 @@ Installation instructions
This is because some Gems have native code, and the bundler versions are
unlikely to be the same.
* `cd` into that directory
-* `git clone [email protected]:apache/whimsy.git` OR
-* `git clone https://github.com/apache/whimsy.git` (whichever works best for
you)
-* `cp whimsy/config/whimsy.template .whimsy`
-* edit the `.whimsy` file as per its comments
+* `git clone [email protected]:apache/whimsy.git` OR \
+ `git clone https://github.com/apache/whimsy.git` (whichever works best for
you)
+* `cp whimsy/config/whimsy.template .whimsy`\
+ edit the `.whimsy` file as per its comments
* Create the file `.bash_aliases` if required - this will be picked up by the
root user
There is a sample template `whimsy/config/bash_aliases.template` to get you
started
* `mkdir apache2_logs` if required - this will be used for the server logs
(makes it easier to review them)
* `cd whimsy`
* Start Docker if necessary: `$ open [~]/Applications/Docker.app`
* `rake docker:update` # this runs docker:build and updates any Gems
-* If you are using a local copy of SVN, you will need to start the server and
run `rake svn:update` from a shell
-* Otherwise you can run `rake svn:update` externally
+* If you are using a local copy of SVN, you will need to start the server and
run `rake svn:update` from a shell on the container\
+ Otherwise you can run `rake svn:update` externally
* `rake docker:up` # This prompts for LDAP Bind password
* visit `http://localhost:1999/` in your favorite browser
@@ -88,7 +88,7 @@ The command does not need to be repeated each time you want
to start the contain
but should be repeated from time to time to fetch updated sources.
If you wish to create the Ubuntu image separately, run `rake docker:build`
-(this is invoked as part of docker:update)
+(this is invoked as part of `docker:update`)
This should be re-run if you update any of the resources used for the build,
e.g. files in docker-config and the Dockerfile
@@ -106,10 +106,10 @@ known yet what functions work and what functions do not.
Installation layout
-------------------
-The `docker-compose.yml` has the following mounts:
+The `compose.yaml` has the following mounts:
-container path host path
-/srv directory chosen in step 1
+ container path host path
+ /srv directory chosen in step 1
You can edit the files in these directories using your host tools.
If any of the configuration files under .subversion etc contain absolute
references to
@@ -141,18 +141,18 @@ If a developer needs such access, they should use a local
SVN repository.
Using a local SVN repository
----------------------------
-Create a directory called REPO (must agree with docker-config/whimsy.conf)
under the whimsy parent directory
+Create a directory called REPO (must agree with `docker-config/whimsy.conf`)
under the `whimsy` parent directory
(i.e. alongside the gems/ directory)
-Set up 3 local SVN repositories under the REPO directory using `svnadmin
create` with the names: asf, private, infra
+Set up 3 local SVN repositories under the REPO directory using `svnadmin
create` with the names: `asf`, `private`, `infra`
Under each of these, create the directories and files you need.
-Add the following entry to the .whimsy file: `:svn_base:
http://localhost/repos/`
+Add the following entry to the `.whimsy` file: `:svn_base:
http://localhost/repos/`
The repositories can then be found at the following locations in Docker:
- http://localhost/repos/asf/
- http://localhost/repos/infra/
- http://localhost/repos/private/
-Note: these will be checked out under /srv/svn in Docker.
+Note: these will be checked out under `/srv/svn` in Docker.
Testing email
-------------
diff --git a/tools/collate_minutes.rb b/tools/collate_minutes.rb
index 0e49fe4a..f34616db 100755
--- a/tools/collate_minutes.rb
+++ b/tools/collate_minutes.rb
@@ -808,7 +808,7 @@ def layout(title = nil)
x.text! "This was extracted (@ #{STAMP}) from a list of"
else # main index, which is always replaced if any input files have
changed
# text below must agree with code that updates the index when no
changes have occurred
- x.text! "Last run: #{STAMP}. The data is extracted from a list of"
+ x.text! "Last collate_minutes.rb run: #{STAMP}. The data is extracted
from a list of"
end
x.a 'minutes', :href =>
'http://www.apache.org/foundation/records/minutes/'
x.text! 'which have been approved by the Board.'
diff --git a/www/board/minutes/.gitignore b/www/board/minutes/.gitignore
index bd540728..000796da 100644
--- a/www/board/minutes/.gitignore
+++ b/www/board/minutes/.gitignore
@@ -1,3 +1,3 @@
# Do not delete this file; it ensures the directory is created on checkout
-# These are generated, but not committed
+# These are generated by tools/collate_minutes.rb, but not committed
*.html
\ No newline at end of file
