You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iceberg.apache.org by ru...@apache.org on 2022/02/08 18:07:34 UTC
[iceberg-docs] 15/47: Rename javadocs -> javadoc (#14)
This is an automated email from the ASF dual-hosted git repository.
russellspitzer pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-docs.git
commit 9f66ddb922b4064cf88103a4b6e0a75f8f5682e1
Author: Samuel Redai <43...@users.noreply.github.com>
AuthorDate: Fri Jan 14 13:43:45 2022 -0800
Rename javadocs -> javadoc (#14)
---
README.md | 14 +++++++-------
docs/content/docs/api/{javadocs => javadoc}/_index.md | 0
docs/layouts/partials/docs/menu-filetree.html | 2 +-
3 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 6788cb1..eef928b 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@ It's built with [Hugo](https://gohugo.io/) and hosted at https://iceberg.apache.
# Structure
The Iceberg documentation site is actually constructed from two hugo sites. The first, is the landing page. The second site,
-is the documentation site which contains the full Iceberg documentation, including the javadocs. The landing page and
+is the documentation site which contains the full Iceberg documentation, including the javadoc. The landing page and
documentation sites are completely self-contained in the `./landing-page` and `./docs` directories, respectively.
# Landing Page Deployment
@@ -42,7 +42,7 @@ named after the branch where the commit occured. This is performed by the `deplo
**except** `main`. A branch is maintained for each Iceberg version. If the job runs and the directory does not
yet exist in the `asf-site` branch, it will be created.
-Additionally, the contents of the `javadocs` directory is deployed to a `javadocs/<branch_name>` directory in
+Additionally, the contents of the `javadoc` directory is deployed to a `javadoc/<branch_name>` directory in
the `asf-site` branch.
#### Latest Docs
@@ -60,17 +60,17 @@ The `asf-site` branch structure is the following:
│ ├── latest
│ │ └── <Full Docs Site @latest>
│ └── index.html <-- Includes a redirect to 0.12.1 which is the latest version
-├── javadocs
+├── javadoc
│ ├── 0.12.1
-│ │ └── <Full javadocs site @0.12.1>
+│ │ └── <Full javadoc site @0.12.1>
│ └── latest
-│ └── <Full javadocs Site @latest>
+│ └── <Full javadoc Site @latest>
└── <Full Landing Page Site>
```
A non-`main` branch commit deploys the docs site into a new sub-directory in the
-`asf-site` branch's `docs` directory, as well as copies the javadocs directory into a new sub-directory
-in the `asf-site` branch's `javadocs` directory.
+`asf-site` branch's `docs` directory, as well as copies the javadoc directory into a new sub-directory
+in the `asf-site` branch's `javadoc` directory.
A `main` branch commit deploys the landing page site **only** and overwrites the landing page site at
the root of the `asf-site` branch.
diff --git a/docs/content/docs/api/javadocs/_index.md b/docs/content/docs/api/javadoc/_index.md
similarity index 100%
rename from docs/content/docs/api/javadocs/_index.md
rename to docs/content/docs/api/javadoc/_index.md
diff --git a/docs/layouts/partials/docs/menu-filetree.html b/docs/layouts/partials/docs/menu-filetree.html
index 7c11790..12f032b 100644
--- a/docs/layouts/partials/docs/menu-filetree.html
+++ b/docs/layouts/partials/docs/menu-filetree.html
@@ -67,7 +67,7 @@
class="book-section-collapsed navigation-icon-pad"
{{ end -}}
>
- <a href="{{ .Page.Site.BaseURL }}/../../javadocs/{{ .Page.Site.Params.versions.iceberg }}">
+ <a href="{{ .Page.Site.BaseURL }}/../../javadoc/{{ .Page.Site.Params.versions.iceberg }}">
{{ template "book-nav-item-logo-image" (dict "Page" .) }}
{{.Title}}
</a>