This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hop-website.git
The following commit(s) were added to refs/heads/main by this push:
new a879aaed16 Issue #8188 : drop the technical documentation component
(#279)
a879aaed16 is described below
commit a879aaed1699d388f6833cd725062d360ab10215
Author: Hans Van Akelyen <[email protected]>
AuthorDate: Mon Aug 31 11:03:36 2026 +0200
Issue #8188 : drop the technical documentation component (#279)
Its pages were folded into the user and developer manuals in apache/hop.
* remove the tech-manual source from both Antora playbooks
* drop the "Technical Documentation" menu entry
* add a Logo and Icons page under Community, pointing at the brand assets
the site already hosts under /graphical_resources/ (the manual carried a
duplicate copy of the same files)
* redirect every /tech-manual/<version>/* URL, in any published version, to
its new home
Co-authored-by: Claude Opus 5 <[email protected]>
---
.htaccess | 15 ++++-
config.toml | 20 +++---
content/community/branding.adoc | 71 ++++++++++++++++++++++
.../documentation-contribution-guide.adoc | 3 +-
site-local.yml | 3 -
site.yml | 15 -----
6 files changed, 96 insertions(+), 31 deletions(-)
diff --git a/.htaccess b/.htaccess
index bd741ac821..7170844bb2 100644
--- a/.htaccess
+++ b/.htaccess
@@ -4,4 +4,17 @@ RewriteBase "/"
# Redirect /manual/2.19.0 to latest
-RewriteRule "^manual/2.19.0(/.*)$" "/manual/latest$1" [R=permanent,L]
\ No newline at end of file
+RewriteRule "^manual/2.19.0(/.*)$" "/manual/latest$1" [R=permanent,L]
+
+# The technical documentation was folded into the user and developer manuals.
+# Redirect its pages, in any published version, to their new homes.
+
+RewriteRule "^tech-manual/[^/]+/hop-vs-kettle/hop-import\.html$"
"/manual/latest/hop-tools/hop-import.html" [R=permanent,L]
+RewriteRule "^tech-manual/[^/]+/hop-vs-kettle/(.*)$"
"/manual/latest/hop-vs-kettle/$1" [R=permanent,L]
+RewriteRule "^tech-manual/[^/]+/docker-container\.html$"
"/manual/latest/docker-container.html" [R=permanent,L]
+RewriteRule "^tech-manual/[^/]+/hop-web-docker\.html$"
"/manual/latest/hop-web-docker.html" [R=permanent,L]
+RewriteRule "^tech-manual/[^/]+/disable-ui-elements\.html$"
"/manual/latest/hop-gui/disable-ui-elements.html" [R=permanent,L]
+RewriteRule "^tech-manual/[^/]+/logging/.*$"
"/dev-manual/latest/architecture/logging-and-debugging.html" [R=permanent,L]
+RewriteRule "^tech-manual/[^/]+/hop-logo-and-icons\.html$"
"/community/branding/" [R=permanent,L]
+RewriteRule "^tech-manual/[^/]+/_attachments/BrandGuideline_Hop\.pdf$"
"/graphical_resources/brand_guideline_hop.pdf" [R=permanent,L]
+RewriteRule "^tech-manual/(.*)$" "/manual/latest/" [R=permanent,L]
diff --git a/config.toml b/config.toml
index 924beeb490..a28df6e968 100644
--- a/config.toml
+++ b/config.toml
@@ -50,31 +50,24 @@ unsafe= true
identifier = "docs-user-manual"
url = "/manual/latest/"
-[[menu.main]]
- name = "Technical Documentation"
- parent = "docs"
- weight = 3
- identifier = "docs-tech-manual"
- url = "/tech-manual/latest/"
-
[[menu.main]]
name = "Developer Documentation"
parent = "docs"
- weight = 4
+ weight = 3
identifier = "docs-dev-manual"
url = "/dev-manual/latest/"
[[menu.main]]
name = "Architecture"
parent = "docs"
- weight = 5
+ weight = 4
identifier = "docs-architecture"
url = "/docs/architecture/"
[[menu.main]]
name = "Roadmap"
parent = "docs"
- weight = 6
+ weight = 5
identifier = "docs-roadmap"
url = "/docs/roadmap/"
@@ -132,6 +125,13 @@ unsafe= true
identifier = "community-ethos"
url = "/community/ethos/"
+[[menu.main]]
+ name = "Logo and Icons"
+ parent = "community"
+ weight = 8
+ identifier = "community-branding"
+ url = "/community/branding/"
+
[[menu.main]]
name = "Download"
weight = 3
diff --git a/content/community/branding.adoc b/content/community/branding.adoc
new file mode 100644
index 0000000000..5a4a703cb8
--- /dev/null
+++ b/content/community/branding.adoc
@@ -0,0 +1,71 @@
+---
+title: "Logo and Icons"
+---
+
+The Apache Hop logo should be used as the main reference to the Apache Hop
project.
+
+The Apache Hop icon should be used in graphical user interfaces like Apache
Hop's Hop Gui. The icon should not be used as a replacement for the Apache Hop
logo.
+
+Vector sources are available as
link:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/hop_logo_cmyk.pdf[CMYK
PDF] and
link:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/hop_logo_rgb.pdf[RGB
PDF].
+
+== Style guide
+
+link:/graphical_resources/brand_guideline_hop.pdf[BrandGuideline_Hop.pdf]
+
+== CMYK for printing
+
+=== Logo
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/jpg/hop_logo_cmyk-4.jpg[Hop
logo CMYK, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/jpg/hop_logo_cmyk-2.jpg[Hop
logo CMYK, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/jpg/hop_logo_cmyk-1.jpg[Hop
logo CMYK, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/jpg/hop_logo_cmyk-3.jpg[Hop
logo CMYK, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/jpg/hop_logo_cmyk-5.jpg[Hop
logo CMYK, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/jpg/hop_logo_cmyk-6.jpg[Hop
logo CMYK, width="50%"]
+
+=== Icon
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/jpg/hop_logo_cmyk-10.jpg[Hop
icon CMYK, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/jpg/hop_logo_cmyk-7.jpg[Hop
icon CMYK, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/jpg/hop_logo_cmyk-8.jpg[Hop
icon CMYK, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/jpg/hop_logo_cmyk-9.jpg[Hop
icon CMYK, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/cmyk_print/jpg/hop_logo_cmyk-12.jpg[Hop
icon CMYK, width="50%"]
+
+== RGB for web usage
+
+=== Logo
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-4.jpg[Hop
logo RGB, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-1.jpg[Hop
logo RGB, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-2.jpg[Hop
logo RGB, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-3.jpg[Hop
logo RGB, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-5.jpg[Hop
logo RGB, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-6.jpg[Hop
logo RGB, width="50%"]
+
+=== Icon
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-10.jpg[Hop
icon RGB, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-7.jpg[Hop
icon RGB, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-8.jpg[Hop
icon RGB, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-9.jpg[Hop
icon RGB, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-11.jpg[Hop
icon RGB, width="50%"]
+
+image:/graphical_resources/hop_logo_and_icon/hop_logo_and_icon/rgb_web/jpg/hop_logo_rgb-12.jpg[Hop
icon RGB, width="50%"]
diff --git
a/content/community/contribution-guides/documentation-contribution-guide.adoc
b/content/community/contribution-guides/documentation-contribution-guide.adoc
index de792e5cf8..380c446f09 100644
---
a/content/community/contribution-guides/documentation-contribution-guide.adoc
+++
b/content/community/contribution-guides/documentation-contribution-guide.adoc
@@ -74,7 +74,7 @@ TIP: The pull request review and merge is a manual process.
Even though it usual
All Apache Hop documentation is maintained in the same git repository as the
code base.
-=== User manual and Technical documentation
+=== User manual
The easiest way to contribute documentation is to fork
https://github.com/apache/hop[Hop’s repository] on GitHub into your own GitHub
account by clicking on the fork button at the top right. If you have no GitHub
account, you can create one for free.
@@ -84,7 +84,6 @@ Next, clone your fork to your local machine.
git clone https://github.com/<your-user-name>/hop.git
The user manual documentation is located in the docs/hop-user-manual/
subdirectory.
-The technical documentation is located in the docs/hop-tech-manual/
subdirectory.
=== API documentation
diff --git a/site-local.yml b/site-local.yml
index 3bd7ea9854..f26ce2c76c 100644
--- a/site-local.yml
+++ b/site-local.yml
@@ -19,9 +19,6 @@ content:
branches:
- HEAD
start_path: /docs/hop-user-manual/
- - url: ../hop/
- branches: HEAD
- start_path: /docs/hop-tech-manual/
- url: ../hop/
branches: HEAD
start_path: /docs/hop-dev-manual/
diff --git a/site.yml b/site.yml
index 550bb2d15c..23ff562185 100644
--- a/site.yml
+++ b/site.yml
@@ -29,21 +29,6 @@ content:
- release/2.18.1
- release/2.19.0
start_path: /docs/hop-user-manual/
- - url: [email protected]:apache/hop.git
- branches:
- - main
- - release/2.10.0
- - release/2.11.0
- - release/2.12.0
- - release/2.13.0
- - release/2.14.0
- - release/2.15.0
- - release/2.16.0
- - release/2.17.0
- - release/2.18.0
- - release/2.18.1
- - release/2.19.0
- start_path: /docs/hop-tech-manual/
- url: [email protected]:apache/hop.git
branches:
- main
