This is an automated email from the ASF dual-hosted git repository.
pingsutw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new 8dc43d4 SUBMARINE-1044. Migrate previous release notes
8dc43d4 is described below
commit 8dc43d4dcb3ef682dd842aee9e074bd9d4f301ce
Author: joshvictor1024 <[email protected]>
AuthorDate: Sat Oct 16 09:21:36 2021 +0800
SUBMARINE-1044. Migrate previous release notes
### What is this PR for?
<!-- A few sentences describing the overall goals of the pull request's
commits.
First time? Check out the contributing guide -
https://submarine.apache.org/contribution/contributions.html
-->
Move release notes from
https://submarine.apache.org/docs/releases/submarine-release-0.2.0 etc. to
https://submarine.apache.org/versions
### What type of PR is it?
[Improvement]
### Todos
### What is the Jira issue?
<!-- * Open an issue on Jira
https://issues.apache.org/jira/browse/SUBMARINE/
* Put link here, and add [SUBMARINE-*Jira number*] in PR title, eg.
`SUBMARINE-23. PR title`
-->
https://issues.apache.org/jira/browse/SUBMARINE-1044
### How should this be tested?
<!--
* First time? Setup Travis CI as described on
https://submarine.apache.org/contribution/contributions.html#continuous-integration
* Strongly recommended: add automated unit tests for any new or changed
behavior
* Outline any manual steps to test the PR here.
-->
Run the development server locally. See
[`website/README`](https://github.com/apache/submarine/blob/master/website/README.md)
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: joshvictor1024 <[email protected]>
Signed-off-by: Kevin <[email protected]>
Closes #777 from joshvictor1024/SUBMARINE-1044 and squashes the following
commits:
267c9034 [joshvictor1024] SUBMARINE-1044. Fix broken links
1a2eb763 [joshvictor1024] SUBMARINE-1044. Migrate previous release notes
---
website/docs/releases/submarine-release-0.4.0.md | 30 --------------------
website/docs/releases/submarine-release-0.5.0.md | 33 ----------------------
website/sidebars.js | 7 -----
.../pages}/releases/submarine-release-0.2.0.md | 7 ++---
.../pages}/releases/submarine-release-0.3.0.md | 8 ++----
.../pages}/releases/submarine-release-0.4.0.md | 8 ++----
.../pages}/releases/submarine-release-0.5.0.md | 6 ++--
.../pages}/releases/submarine-release-0.6.0.md | 6 ++--
website/src/pages/versions.js | 21 ++++++++++++--
.../releases/submarine-release-0.2.0.md | 26 -----------------
.../releases/submarine-release-0.3.0.md | 30 --------------------
.../versioned_sidebars/version-0.6.0-sidebars.json | 6 ----
website/versionsReleaseNoteOnly.json | 6 ++++
13 files changed, 37 insertions(+), 157 deletions(-)
diff --git a/website/docs/releases/submarine-release-0.4.0.md
b/website/docs/releases/submarine-release-0.4.0.md
deleted file mode 100755
index 243c99f..0000000
--- a/website/docs/releases/submarine-release-0.4.0.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-title: "Apache Submarine Release 0.4.0"
----
-
-<!--
-Licensed 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.
--->
-
-The Apache Submarine Community is pleased to announce the availability of the
`0.4.0` release.
-
-The community put significant effort into improving Apache Submarine since the
last release.
-175 patches for improvements and bug fixes. The highlighted features are as
follows:
-
-- Submarine Experiments: Refactor the Job to experiment and redefined the
experiment spec
-- Submarine Helm Charts: Provides one command to install the submarine into
the Kubernetes cluster
-- PySubmarine: Submarine Python SDK
-
-We encourage to [download](../download) the latest release. Feedback through
the [mailing lists](../community/README) is very welcome.
-
-You can visit [issue
tracker](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12322824&version=12346621)
for full list of issues that are resolved.
diff --git a/website/docs/releases/submarine-release-0.5.0.md
b/website/docs/releases/submarine-release-0.5.0.md
deleted file mode 100755
index 862aeb0..0000000
--- a/website/docs/releases/submarine-release-0.5.0.md
+++ /dev/null
@@ -1,33 +0,0 @@
----
-title: "Apache Submarine Release 0.5.0"
----
-<!--
-Licensed 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.
--->
-
-
-The Apache Submarine Community is pleased to announce the availability of the
`0.5.0` release.
-
-The community put significant effort into improving Apache Submarine since the
last release.
-99 patches for improvements and bug fixes. The highlighted features are as
follows:
-
-- Submarine Experiments: Redefined the experiment spec, sync up code from Git,
it could be HTTP and ssh
-- Predefined experiment template: Register A experiment template and submit
the related parameter to run an experiment using Rest API
-- Environment profile: Users could easily manage their docker image and conda
environment
-- Jupyter Notebook: Spawn a jupyter notebook using Rest API, and execute ML
code on K8s, or submit an experiment to submarine server
-- Submarine Workbench UI: CRUD Experiment, Environment, Notebook through the
UI
-- Disable interpreter module
-
-We encourage to [download](../download) the latest release. Feedback through
the [mailing lists](../community/README) is very welcome.
-
-You can visit [issue
tracker](https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12348041&projectId=12322824)
for full list of issues that are resolved.
diff --git a/website/sidebars.js b/website/sidebars.js
index 028de90..535c748 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -96,13 +96,6 @@ module.exports = {
],
},
],
- Releases: [
- "releases/submarine-release-0.2.0",
- "releases/submarine-release-0.3.0",
- "releases/submarine-release-0.4.0",
- "releases/submarine-release-0.5.0",
- "releases/submarine-release-0.6.0",
- ],
RoadMap: [],
},
],
diff --git a/website/docs/releases/submarine-release-0.2.0.md
b/website/src/pages/releases/submarine-release-0.2.0.md
old mode 100755
new mode 100644
similarity index 83%
rename from website/docs/releases/submarine-release-0.2.0.md
rename to website/src/pages/releases/submarine-release-0.2.0.md
index 6f4b2c1..0064d16
--- a/website/docs/releases/submarine-release-0.2.0.md
+++ b/website/src/pages/releases/submarine-release-0.2.0.md
@@ -1,6 +1,3 @@
----
-title: "Apache Submarine Release 0.2.0"
----
<!--
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,12 +12,14 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
+# Apache Submarine Release 0.2.0
+
The Apache Submarine community is pleased to announce the availability of the
`0.2.0` release.
The community put significant effort into improving Apache Submarine since the
last release.
46 patches for improvements and bug fixes.
-We encourage to [download](../download) the latest release. Feedback through
the [mailing lists](../community/README) is very welcome.
+We encourage to [download](/docs/download) the latest release. Feedback
through the [mailing lists](/docs/community/README) is very welcome.
You can visit [issue
tracker](https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12343240&styleName=&projectId=12316221)
for full list of issues that are resolved.
diff --git a/website/docs/releases/submarine-release-0.3.0.md
b/website/src/pages/releases/submarine-release-0.3.0.md
old mode 100755
new mode 100644
similarity index 86%
rename from website/docs/releases/submarine-release-0.3.0.md
rename to website/src/pages/releases/submarine-release-0.3.0.md
index 6dccbd3..71dba61
--- a/website/docs/releases/submarine-release-0.3.0.md
+++ b/website/src/pages/releases/submarine-release-0.3.0.md
@@ -1,7 +1,3 @@
----
-title: "Apache Submarine Release 0.3.0"
----
-
<!--
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -16,6 +12,8 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
+# Apache Submarine Release 0.3.0
+
The Apache Submarine community is pleased to announce the availability of the
`0.3.0` release.
The community put significant effort into improving Apache Submarine since the
last release.
@@ -25,6 +23,6 @@ The community put significant effort into improving Apache
Submarine since the l
- Basic Tensorflow job submission to k8s through submarine-server RESTful API
- Job submission on YARN through submarine-server RPC protocol
-We encourage to [download](../download) the latest release. Feedback through
the [mailing lists](../community/README) is very welcome.
+We encourage to [download](/docs/download) the latest release. Feedback
through the [mailing lists](/docs/community/README) is very welcome.
You can visit [issue
tracker](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12322824&version=12345556)
for full list of issues that are resolved.
diff --git
a/website/versioned_docs/version-0.6.0/releases/submarine-release-0.4.0.md
b/website/src/pages/releases/submarine-release-0.4.0.md
similarity index 86%
rename from
website/versioned_docs/version-0.6.0/releases/submarine-release-0.4.0.md
rename to website/src/pages/releases/submarine-release-0.4.0.md
index 243c99f..cd25823 100644
--- a/website/versioned_docs/version-0.6.0/releases/submarine-release-0.4.0.md
+++ b/website/src/pages/releases/submarine-release-0.4.0.md
@@ -1,7 +1,3 @@
----
-title: "Apache Submarine Release 0.4.0"
----
-
<!--
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -16,6 +12,8 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
+# Apache Submarine Release 0.4.0
+
The Apache Submarine Community is pleased to announce the availability of the
`0.4.0` release.
The community put significant effort into improving Apache Submarine since the
last release.
@@ -25,6 +23,6 @@ The community put significant effort into improving Apache
Submarine since the l
- Submarine Helm Charts: Provides one command to install the submarine into
the Kubernetes cluster
- PySubmarine: Submarine Python SDK
-We encourage to [download](../download) the latest release. Feedback through
the [mailing lists](../community/README) is very welcome.
+We encourage to [download](/docs/download) the latest release. Feedback
through the [mailing lists](/docs/community/README) is very welcome.
You can visit [issue
tracker](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12322824&version=12346621)
for full list of issues that are resolved.
diff --git
a/website/versioned_docs/version-0.6.0/releases/submarine-release-0.5.0.md
b/website/src/pages/releases/submarine-release-0.5.0.md
similarity index 89%
rename from
website/versioned_docs/version-0.6.0/releases/submarine-release-0.5.0.md
rename to website/src/pages/releases/submarine-release-0.5.0.md
index 862aeb0..f6cc969 100644
--- a/website/versioned_docs/version-0.6.0/releases/submarine-release-0.5.0.md
+++ b/website/src/pages/releases/submarine-release-0.5.0.md
@@ -1,6 +1,3 @@
----
-title: "Apache Submarine Release 0.5.0"
----
<!--
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,6 +12,7 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
+# Apache Submarine Release 0.5.0
The Apache Submarine Community is pleased to announce the availability of the
`0.5.0` release.
@@ -28,6 +26,6 @@ The community put significant effort into improving Apache
Submarine since the l
- Submarine Workbench UI: CRUD Experiment, Environment, Notebook through the
UI
- Disable interpreter module
-We encourage to [download](../download) the latest release. Feedback through
the [mailing lists](../community/README) is very welcome.
+We encourage to [download](/docs/download) the latest release. Feedback
through the [mailing lists](/docs/community/README) is very welcome.
You can visit [issue
tracker](https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12348041&projectId=12322824)
for full list of issues that are resolved.
diff --git a/website/docs/releases/submarine-release-0.6.0.md
b/website/src/pages/releases/submarine-release-0.6.0.md
similarity index 85%
rename from website/docs/releases/submarine-release-0.6.0.md
rename to website/src/pages/releases/submarine-release-0.6.0.md
index 3207f7c..0cd8257 100644
--- a/website/docs/releases/submarine-release-0.6.0.md
+++ b/website/src/pages/releases/submarine-release-0.6.0.md
@@ -1,6 +1,3 @@
----
-title: "Apache Submarine Release 0.6.0"
----
<!--
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -15,6 +12,7 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
+# Apache Submarine Release 0.6.0
The Apache Submarine Community is pleased to announce the availability of the
`0.6.0` release.
@@ -26,6 +24,6 @@ The community put significant effort into improving Apache
Submarine since the l
- Submarine operator
- Improve workbench UI/UX
-We encourage to [download](../download) the latest release. Feedback through
the [mailing lists](../community/README) is very welcome.
+We encourage to [download](/docs/download) the latest release. Feedback
through the [mailing lists](/docs/community/README) is very welcome.
You can visit [issue
tracker](https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12348821&styleName=Html&projectId=12322824)
for full list of issues that are resolved.
diff --git a/website/src/pages/versions.js b/website/src/pages/versions.js
index 3830094..737a3df 100644
--- a/website/src/pages/versions.js
+++ b/website/src/pages/versions.js
@@ -22,6 +22,8 @@
import Layout from '@theme/Layout';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import {useVersions, useLatestVersion} from '@theme/hooks/useDocs';
+
+ import versionsReleaseNoteOnly from '@site/versionsReleaseNoteOnly.json';
function Version() {
const versions = useVersions();
@@ -56,7 +58,7 @@ function Version() {
<Link to={latestVersion.path}>Documentation</Link>
</td>
<td>
- <a href={`${repoUrl}/releases/tag/v${latestVersion.name}`}>
+ <a
href={`/releases/submarine-release-${latestVersion.name}`}>
Release Notes
</a>
</td>
@@ -89,7 +91,7 @@ function Version() {
</div>
)}
- {pastVersions.length > 0 && (
+ {(pastVersions.length + versionsReleaseNoteOnly.length) > 0 && (
<div className="margin-bottom--lg">
<h3 id="archive">Past versions (Not maintained anymore)</h3>
<p>
@@ -105,7 +107,20 @@ function Version() {
<Link to={version.path}>Documentation</Link>
</td>
<td>
- <a href={`${repoUrl}/releases/tag/v${version.name}`}>
+ <a href={`/releases/submarine-release-${version.name}`}>
+ Release Notes
+ </a>
+ </td>
+ </tr>
+ ))}
+ {versionsReleaseNoteOnly.map((version) => (
+ <tr key={version}>
+ <th>{version}</th>
+ <td>
+ Documentation
+ </td>
+ <td>
+ <a href={`/releases/submarine-release-${version}`}>
Release Notes
</a>
</td>
diff --git
a/website/versioned_docs/version-0.6.0/releases/submarine-release-0.2.0.md
b/website/versioned_docs/version-0.6.0/releases/submarine-release-0.2.0.md
deleted file mode 100644
index 6f4b2c1..0000000
--- a/website/versioned_docs/version-0.6.0/releases/submarine-release-0.2.0.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
-title: "Apache Submarine Release 0.2.0"
----
-<!--
-Licensed 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.
--->
-
-The Apache Submarine community is pleased to announce the availability of the
`0.2.0` release.
-
-The community put significant effort into improving Apache Submarine since the
last release.
-46 patches for improvements and bug fixes.
-
-We encourage to [download](../download) the latest release. Feedback through
the [mailing lists](../community/README) is very welcome.
-
-You can visit [issue
tracker](https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12343240&styleName=&projectId=12316221)
for full list of issues that are resolved.
-
diff --git
a/website/versioned_docs/version-0.6.0/releases/submarine-release-0.3.0.md
b/website/versioned_docs/version-0.6.0/releases/submarine-release-0.3.0.md
deleted file mode 100644
index 6dccbd3..0000000
--- a/website/versioned_docs/version-0.6.0/releases/submarine-release-0.3.0.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-title: "Apache Submarine Release 0.3.0"
----
-
-<!--
-Licensed 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.
--->
-
-The Apache Submarine community is pleased to announce the availability of the
`0.3.0` release.
-
-The community put significant effort into improving Apache Submarine since the
last release.
-196 patches for improvements and bug fixes. The highlighted features are as
follows:
-
-- Mini-submarine (YARN)
-- Basic Tensorflow job submission to k8s through submarine-server RESTful API
-- Job submission on YARN through submarine-server RPC protocol
-
-We encourage to [download](../download) the latest release. Feedback through
the [mailing lists](../community/README) is very welcome.
-
-You can visit [issue
tracker](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12322824&version=12345556)
for full list of issues that are resolved.
diff --git a/website/versioned_sidebars/version-0.6.0-sidebars.json
b/website/versioned_sidebars/version-0.6.0-sidebars.json
index 55938b3..e9582ed 100644
--- a/website/versioned_sidebars/version-0.6.0-sidebars.json
+++ b/website/versioned_sidebars/version-0.6.0-sidebars.json
@@ -76,12 +76,6 @@
]
}
],
- "Releases": [
-
"version-0.6.0/releases/submarine-release-0.2.0",
-
"version-0.6.0/releases/submarine-release-0.3.0",
-
"version-0.6.0/releases/submarine-release-0.4.0",
- "version-0.6.0/releases/submarine-release-0.5.0"
- ],
"RoadMap": []
}
],
diff --git a/website/versionsReleaseNoteOnly.json
b/website/versionsReleaseNoteOnly.json
new file mode 100644
index 0000000..ad23336
--- /dev/null
+++ b/website/versionsReleaseNoteOnly.json
@@ -0,0 +1,6 @@
+[
+ "0.5.0",
+ "0.4.0",
+ "0.3.0",
+ "0.2.0"
+]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]