From 249ae9d5ab6dde37e7dd310ac109fad9548d07a8 Mon Sep 17 00:00:00 2001 From: Wayne Beaton <wayne.beaton@eclipse-foundation.org> Date: Thu, 9 Mar 2023 10:22:34 -0500 Subject: [PATCH] Configuration and documentation fixes --- CONTRIBUTING.md | 10 ++++++++-- source/chapters/notices.adoc | 4 +--- source/config.adoc | 2 -- source/eclipse.adoc | 3 +++ source/handbook.css | 1 + 5 files changed, 13 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 74683d9..b3f1747 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,9 +50,15 @@ contributions are always welcome! We use Maven to build. - mvn compile + mvn clean verify -Content is rendered into the `./target` folder in HTML, PDF, and EPUB formats. +Content is rendered into the `./target` folder in HTML, and PDF formats. + +Publishing the build currently requires some manual steps. Assuming that the `/projects` website repository is cloned at `/gitroot/www.eclipse.org/projects` (if otherwise, adjust accordingly), use the following command to build and push the result to the local copy of the website: + + mvn clean verify && cp target/generated-docs/eclipse.html /gitroot/www.eclipse.org/projects/handbook/. + +When ready to publish, use the standard Git mechanism to create a new commit and push to the `/projects` repository. The `README.md` file contains information regarding how we structure documents and other guidelines regarding content. diff --git a/source/chapters/notices.adoc b/source/chapters/notices.adoc index 68532db..cfa6411 100644 --- a/source/chapters/notices.adoc +++ b/source/chapters/notices.adoc @@ -20,6 +20,4 @@ Copyright (C) Eclipse Foundation, Inc. and others. Made available under the {epl20Url}[Eclipse Public License v 2.0]. -This document includes content originally authored on the http://wiki.eclipse.org[Eclipsepedia wiki] by Wayne Beaton, Fabian Steeg, Denis Roy, Dave Carver, Ed Merks, Bjorn Freeman-Benson, Anne Jacko, Ian Skerrett, Mike Milinkovich, and John Arthorne. - -Version {project-version}. \ No newline at end of file +This document includes content originally authored on the http://wiki.eclipse.org[Eclipsepedia wiki] by Wayne Beaton, Fabian Steeg, Denis Roy, Dave Carver, Ed Merks, Bjorn Freeman-Benson, Anne Jacko, Ian Skerrett, Mike Milinkovich, and John Arthorne. \ No newline at end of file diff --git a/source/config.adoc b/source/config.adoc index 01fb0a0..0a49d7a 100644 --- a/source/config.adoc +++ b/source/config.adoc @@ -121,8 +121,6 @@ :stylesdir: ./resources :scriptsdir: ./resources -:toc: -:toc-placement: auto :icons: font :doctype: book diff --git a/source/eclipse.adoc b/source/eclipse.adoc index 53989d3..c443055 100644 --- a/source/eclipse.adoc +++ b/source/eclipse.adoc @@ -31,8 +31,11 @@ include::config.adoc[] :pmiSampleImage: images/pmi-egit25.png + = Eclipse Foundation Project Handbook +Current as of {localdate}. + include::chapters/notices.adoc[] include::chapters/preamble.adoc[] diff --git a/source/handbook.css b/source/handbook.css index 4c6a79f..7f522f3 100644 --- a/source/handbook.css +++ b/source/handbook.css @@ -17,6 +17,7 @@ .imageblock img { max-width: 100%; + height: auto; } #toc { border-bottom: 0 solid #dddddd; padding-bottom: 0.5em; } #toc > ul { margin-left: 0.13333em; } -- GitLab