This is an automated email from the ASF dual-hosted git repository.
danny0405 pushed a commit to branch site
in repository https://gitbox.apache.org/repos/asf/calcite.git
The following commit(s) were added to refs/heads/site by this push:
new 98b61a4 Site: Fix links to javadoc
98b61a4 is described below
commit 98b61a4b1eed2992a25aed0d3995109ec45faa4a
Author: yuzhao.cyz <yuzhao....@gmail.com>
AuthorDate: Thu Mar 5 06:31:45 2020 -0600
Site: Fix links to javadoc
---
site/README.md | 18 ++++++++----------
site/_config.yml | 10 +++-------
site/_data/docs.yml | 1 -
site/_docs/api.md | 2 +-
site/_docs/testapi.md | 28 ----------------------------
site/_includes/section_nav.html | 2 +-
site/docker-compose.yml | 2 +-
7 files changed, 14 insertions(+), 49 deletions(-)
diff --git a/site/README.md b/site/README.md
index 13c1ed5..8cbac2b 100644
--- a/site/README.md
+++ b/site/README.md
@@ -42,12 +42,12 @@ Site generation currently works best with ruby-2.5.1.
1. `cd ..`
2. `./gradlew javadocAggregate`
-3. `rm -rf site/target/apidocs site/target/testapidocs`
- `rmdir site\target\apidocs site\target\testapidocs /S /Q` (Windows)
+3. `rm -rf site/target/javadocAggregate`
+ `rmdir site\target\javadocAggregate /S /Q` (Windows)
4. `mkdir site/target`
`mkdir site\target` (Windows)
-4. `mv build/docs/javadocAggregate site/target/apidocs`
- `for /d %a in (target\site\apidocs* target\site\testapidocs*) do move %a
site\target` (Windows)
+4. `mv build/docs/javadocAggregate site/target`
+ `for /d %a in (build\docs\javadocAggregate*) do move %a site\target`
(Windows)
### Running locally
@@ -94,15 +94,13 @@ As you make changes to the site, the site will
automatically rebuild.
If you have not regenerated the javadoc and they are missing, restore them:
-6. `git reset -- apidocs/`
-7. `git reset -- testapidocs/`
-8. `git checkout -- apidocs/`
-9. `git checkout -- testapidocs/`
+6. `git reset -- javadocAggregate/`
+7. `git checkout -- javadocAggregate/`
Restore the avatica site
-10. `git reset -- avatica/`
-11. `git checkout -- avatica/`
+8. `git reset -- avatica/`
+9. `git checkout -- avatica/`
10. `git add .`
11. Commit: `git commit -m "Your commit message goes here"`
diff --git a/site/_config.yml b/site/_config.yml
index c9fa570..402c7d0 100644
--- a/site/_config.yml
+++ b/site/_config.yml
@@ -21,7 +21,7 @@ excerpt_separator: ""
repository: https://github.com/apache/calcite
destination: target
exclude: [README.md,Gemfile*]
-keep_files: [".git", ".svn", "apidocs", "testapidocs", "avatica",
"docs/cassandra.html"]
+keep_files: [".git", ".svn", "javadocAggregate", "avatica",
"docs/cassandra.html"]
collections:
docs:
@@ -31,12 +31,8 @@ collections:
sourceRoot: https://github.com/apache/calcite/blob/master
# The URL where Javadocs are located
-apiRoot: /apidocs
-# apiRoot: http://calcite.apache.org/apidocs
-
-# The URL where Test Javadocs are located
-testApiRoot: /testapidocs
-# testApiRoot: http://calcite.apache.org/testapidocs
+apiRoot: /javadocAggregate
+# apiRoot: http://calcite.apache.org/javadocAggregate
# The URL where Avatica's Javadocs are located
avaticaApiRoot: /avatica/apidocs
diff --git a/site/_data/docs.yml b/site/_data/docs.yml
index 3a13d5d..5a6a714 100644
--- a/site/_data/docs.yml
+++ b/site/_data/docs.yml
@@ -49,5 +49,4 @@
- history
- powered_by
- api
- - testapi
# End docs.yml
diff --git a/site/_docs/api.md b/site/_docs/api.md
index 5ad8688..d9d9419 100644
--- a/site/_docs/api.md
+++ b/site/_docs/api.md
@@ -1,7 +1,7 @@
---
title: API
layout: external
-external_url: /apidocs
+external_url: /javadocAggregate
---
{% comment %}
Ideally, we want to use {{ site.apiRoot }} instead of hardcoding
diff --git a/site/_docs/testapi.md b/site/_docs/testapi.md
deleted file mode 100644
index 661f374..0000000
--- a/site/_docs/testapi.md
+++ /dev/null
@@ -1,28 +0,0 @@
----
-title: Test API
-layout: external
-external_url: /testapidocs
----
-{% comment %}
-Ideally, we want to use {{ site.apiRoot }} instead of hardcoding
-the above external_url value, but I don't believe there's a way to do that
-{% endcomment %}
-
-<!--
-{% comment %}
-Licensed to the Apache Software Foundation (ASF) under one or more
-contributor license agreements. See the NOTICE file distributed with
-this work for additional information regarding copyright ownership.
-The ASF licenses this file to you under the Apache License, Version 2.0
-(the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-{% endcomment %}
--->
diff --git a/site/_includes/section_nav.html b/site/_includes/section_nav.html
index e154275..48b112f 100644
--- a/site/_includes/section_nav.html
+++ b/site/_includes/section_nav.html
@@ -33,7 +33,7 @@ next, lets build a link to it.
{% comment %}
See CALCITE-2036 for an explanation of the replacement below
{% endcomment %}
- <a href="{{ next_page | replace: '/docs/api.html', '/apidocs/' }}"
class="next">Next</a>
+ <a href="{{ next_page | replace: '/docs/api.html',
'/javadocAggregate/' }}" class="next">Next</a>
{% endif %}
</div>
</div>
diff --git a/site/docker-compose.yml b/site/docker-compose.yml
index 9ae4fbc..8299e3f 100644
--- a/site/docker-compose.yml
+++ b/site/docker-compose.yml
@@ -31,7 +31,7 @@ services:
generate-javadoc:
image: maven
working_dir: /usr/src/calcite
- command: sh -c "./gradlew javadocAggregate; rm -rf site/target/apidocs
site/target/testapidocs; mkdir -p site/target; mv build/docs/javadocAggregate
site/target/apidocs"
+ command: sh -c "./gradlew javadocAggregate; rm -rf
site/target/javadocAggregate; mkdir -p site/target; mv
build/docs/javadocAggregate site/target"
volumes:
- ../:/usr/src/calcite
- maven-repo:/root/.m2
