This is an automated email from the ASF dual-hosted git repository.
srowen pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/spark-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 642d1fb834 make hyperlinks clickable & fix link
642d1fb834 is described below
commit 642d1fb834817014e1799e73882d53650c1c1662
Author: panbingkun <pbk1...@gmail.com>
AuthorDate: Sat Sep 9 08:24:02 2023 -0500
make hyperlinks clickable & fix link
The pr aims to:
- make hyperlinks clickable to improve document usability
- fix some link to reduce one jump.
Author: panbingkun <pbk1...@gmail.com>
Closes #475 from panbingkun/make_hyperlinks_clickable.
---
README.md | 2 +-
committers.md | 9 +++------
developer-tools.md | 2 +-
release-process.md | 16 ++++++++++------
security.md | 2 +-
site/committers.html | 9 +++------
site/developer-tools.html | 2 +-
site/release-process.html | 16 ++++++++++------
site/security.html | 2 +-
9 files changed, 31 insertions(+), 29 deletions(-)
diff --git a/README.md b/README.md
index ea34048ae7..3e6492c921 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ Building the site requires [Jekyll](http://jekyllrb.com/docs)
The easiest way to install the right version of these tools is using
[Bundler](https://bundler.io/) and running `bundle install` in this directory.
-See also https://github.com/apache/spark/blob/master/docs/README.md
+See also
[https://github.com/apache/spark/blob/master/docs/README.md](https://github.com/apache/spark/blob/master/docs/README.md)
A site build will update the directories and files in the `site` directory
with the generated files.
Using Jekyll via `bundle exec jekyll` locks it to the right version.
diff --git a/committers.md b/committers.md
index 2431d73f84..a555424026 100644
--- a/committers.md
+++ b/committers.md
@@ -197,8 +197,8 @@ origin g...@github.com:[your username]/spark.git (push)
For the `apache` repo, you will need to set up command-line authentication to
GitHub. This may
include setting up an SSH key and/or personal access token. See:
-- https://help.github.com/articles/connecting-to-github-with-ssh/
--
https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/
+-
[https://docs.github.com/en/authentication/connecting-to-github-with-ssh](https://docs.github.com/en/authentication/connecting-to-github-with-ssh)
+-
[https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
To check whether the necessary write access are already granted please visit
[GitBox](https://gitbox.apache.org/setup/).
@@ -219,10 +219,7 @@ Then, in a separate window, modify the code and push a
commit. Run `git rebase -
You can verify the result is one change with `git log`. Then resume the script
in the other window.
Also, please remember to set Assignee on JIRAs where applicable when they are
resolved. The script
-can do this automatically in most cases. However where the contributor is not
yet a part of the
-Contributors group for the Spark project in ASF JIRA, it won't work until they
are added. Ask
-an admin to add the person to Contributors at
-https://issues.apache.org/jira/plugins/servlet/project-config/SPARK/roles .
+can do this automatically in most cases.
Once a PR is merged please leave a comment on the PR stating which branch(es)
it has been merged with.
diff --git a/developer-tools.md b/developer-tools.md
index 73e708116e..59850dbe19 100644
--- a/developer-tools.md
+++ b/developer-tools.md
@@ -193,7 +193,7 @@ Please check other available options via
`python/run-tests[-with-coverage] --hel
Although GitHub Action provide both K8s unit test and integration test
coverage, you can run it locally. For example, Volcano batch scheduler
integration test should be done manually. Please refer the integration test
documentation for the detail.
-https://github.com/apache/spark/blob/master/resource-managers/kubernetes/integration-tests/README.md
+[https://github.com/apache/spark/blob/master/resource-managers/kubernetes/integration-tests/README.md](https://github.com/apache/spark/blob/master/resource-managers/kubernetes/integration-tests/README.md)
<h3>Testing with GitHub actions workflow</h3>
diff --git a/release-process.md b/release-process.md
index 101db9a8b3..87a1ab6778 100644
--- a/release-process.md
+++ b/release-process.md
@@ -31,9 +31,9 @@ The release manager role in Spark means you are responsible
for a few different
If you are a new Release Manager, you can read up on the process from the
followings:
-- release signing https://www.apache.org/dev/release-signing.html
-- gpg for signing https://www.apache.org/dev/openpgp.html
-- svn https://www.apache.org/dev/version-control.html#https-svn
+- release signing
[https://www.apache.org/dev/release-signing.html](https://www.apache.org/dev/release-signing.html)
+- gpg for signing
[https://www.apache.org/dev/openpgp.html](https://www.apache.org/dev/openpgp.html)
+- svn
[https://infra.apache.org/version-control.html#svn](https://infra.apache.org/version-control.html#svn)
<h3>Preparing gpg key</h3>
@@ -222,8 +222,11 @@ It may take a while for them to be visible. This will be
mirrored throughout the
Check the release checker result of the release at <a
href="https://checker.apache.org/projs/spark.html";>https://checker.apache.org/projs/spark.html</a>.
-For Maven Central Repository, you can Release from the <a
href="https://repository.apache.org/";>Apache Nexus Repository Manager</a>. This
is already populated by the `release-build.sh publish-release` step. Log in,
open Staging Repositories, find the one voted on (eg. orgapachespark-1257 for
https://repository.apache.org/content/repositories/orgapachespark-1257/),
select and click Release and confirm. If successful, it should show up under
https://repository.apache.org/content/repositori [...]
-and the same under
https://repository.apache.org/content/groups/maven-staging-group/org/apache/spark/spark-core_2.11/2.2.1/
(look for the correct release version). After some time this will be sync'd to
<a href="https://search.maven.org/";>Maven Central</a> automatically.
+For Maven Central Repository, you can Release from the <a
href="https://repository.apache.org/";>Apache Nexus Repository Manager</a>. This
is already populated by the `release-build.sh publish-release` step. Log in,
+open Staging Repositories, find the one voted on (eg. orgapachespark-1257 for
[https://repository.apache.org/content/repositories/orgapachespark-1257/](https://repository.apache.org/content/repositories/orgapachespark-1257/)),
+select and click Release and confirm. If successful, it should show up under
[https://repository.apache.org/content/repositories/releases/org/apache/spark/spark-core_2.11/2.2.1/](https://repository.apache.org/content/repositories/releases/org/apache/spark/spark-core_2.11/2.2.1/)
+and the same under
[https://repository.apache.org/content/groups/maven-staging-group/org/apache/spark/spark-core_2.11/2.2.1/](https://repository.apache.org/content/groups/maven-staging-group/org/apache/spark/spark-core_2.11/2.2.1/)
+(look for the correct release version). After some time this will be sync'd to
<a href="https://search.maven.org/";>Maven Central</a> automatically.
<h4>Upload to PyPI</h4>
@@ -347,7 +350,8 @@ commit to force synchronization between ASF's git and the
web site, and also the
For some reason synchronization seems to not be reliable for this repository.
On a related note, make sure the version is marked as released on JIRA. Go
find the release page as above, eg.,
-`https://issues.apache.org/jira/projects/SPARK/versions/12340295`, and click
the "Release" button on the right and enter the release date.
+[`https://issues.apache.org/jira/projects/SPARK/versions/12340295`](https://issues.apache.org/jira/projects/SPARK/versions/12340295),
+and click the "Release" button on the right and enter the release date.
(Generally, this is only for major and minor, but not patch releases) The
contributors list can be automatically generated through
<a
href="https://github.com/apache/spark/blob/branch-1.1/dev/create-release/generate-contributors.py";>this
script</a>.
diff --git a/security.md b/security.md
index 182b1e8ef7..cda45f0566 100644
--- a/security.md
+++ b/security.md
@@ -244,7 +244,7 @@ Mitigation:
Enable authentication on any Spark standalone cluster that is not otherwise
secured
from unwanted access, for example by network-level restrictions. Use
`spark.authenticate`
-and related security properties described at
https://spark.apache.org/docs/latest/security.html
+and related security properties described at
[https://spark.apache.org/docs/latest/security.html](https://spark.apache.org/docs/latest/security.html)
Credit:
diff --git a/site/committers.html b/site/committers.html
index 5b194def27..d54c96e931 100644
--- a/site/committers.html
+++ b/site/committers.html
@@ -588,8 +588,8 @@ origin g...@github.com:[your username]/spark.git (push)
include setting up an SSH key and/or personal access token. See:</p>
<ul>
- <li>https://help.github.com/articles/connecting-to-github-with-ssh/</li>
-
<li>https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/</li>
+ <li><a
href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh";>https://docs.github.com/en/authentication/connecting-to-github-with-ssh</a></li>
+ <li><a
href="https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens";>https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens</a></li>
</ul>
<p>To check whether the necessary write access are already granted please
visit <a href="https://gitbox.apache.org/setup/";>GitBox</a>.</p>
@@ -611,10 +611,7 @@ Then, in a separate window, modify the code and push a
commit. Run <code class="
You can verify the result is one change with <code class="language-plaintext
highlighter-rouge">git log</code>. Then resume the script in the other
window.</p>
<p>Also, please remember to set Assignee on JIRAs where applicable when they
are resolved. The script
-can do this automatically in most cases. However where the contributor is not
yet a part of the
-Contributors group for the Spark project in ASF JIRA, it won’t work
until they are added. Ask
-an admin to add the person to Contributors at
-https://issues.apache.org/jira/plugins/servlet/project-config/SPARK/roles .</p>
+can do this automatically in most cases.</p>
<p>Once a PR is merged please leave a comment on the PR stating which
branch(es) it has been merged with.</p>
diff --git a/site/developer-tools.html b/site/developer-tools.html
index 9da1c80772..334195939d 100644
--- a/site/developer-tools.html
+++ b/site/developer-tools.html
@@ -299,7 +299,7 @@ Generating HTML files for PySpark coverage under
/.../spark/python/test_coverage
<p>Although GitHub Action provide both K8s unit test and integration test
coverage, you can run it locally. For example, Volcano batch scheduler
integration test should be done manually. Please refer the integration test
documentation for the detail.</p>
-<p>https://github.com/apache/spark/blob/master/resource-managers/kubernetes/integration-tests/README.md</p>
+<p><a
href="https://github.com/apache/spark/blob/master/resource-managers/kubernetes/integration-tests/README.md";>https://github.com/apache/spark/blob/master/resource-managers/kubernetes/integration-tests/README.md</a></p>
<h3>Testing with GitHub actions workflow</h3>
diff --git a/site/release-process.html b/site/release-process.html
index 6c867fd182..319600a8a4 100644
--- a/site/release-process.html
+++ b/site/release-process.html
@@ -158,9 +158,9 @@
<p>If you are a new Release Manager, you can read up on the process from the
followings:</p>
<ul>
- <li>release signing https://www.apache.org/dev/release-signing.html</li>
- <li>gpg for signing https://www.apache.org/dev/openpgp.html</li>
- <li>svn https://www.apache.org/dev/version-control.html#https-svn</li>
+ <li>release signing <a
href="https://www.apache.org/dev/release-signing.html";>https://www.apache.org/dev/release-signing.html</a></li>
+ <li>gpg for signing <a
href="https://www.apache.org/dev/openpgp.html";>https://www.apache.org/dev/openpgp.html</a></li>
+ <li>svn <a
href="https://infra.apache.org/version-control.html#svn";>https://infra.apache.org/version-control.html#svn</a></li>
</ul>
<h3>Preparing gpg key</h3>
@@ -346,8 +346,11 @@ curl "https://dist.apache.org/repos/dist/dev/spark/KEYS";
> svn-spark/KEYS
It may take a while for them to be visible. This will be mirrored throughout
the Apache network.
Check the release checker result of the release at <a
href="https://checker.apache.org/projs/spark.html";>https://checker.apache.org/projs/spark.html</a>.</p>
-<p>For Maven Central Repository, you can Release from the <a
href="https://repository.apache.org/";>Apache Nexus Repository Manager</a>. This
is already populated by the <code class="language-plaintext
highlighter-rouge">release-build.sh publish-release</code> step. Log in, open
Staging Repositories, find the one voted on (eg. orgapachespark-1257 for
https://repository.apache.org/content/repositories/orgapachespark-1257/),
select and click Release and confirm. If successful, it should sho [...]
-and the same under
https://repository.apache.org/content/groups/maven-staging-group/org/apache/spark/spark-core_2.11/2.2.1/
(look for the correct release version). After some time this will be
sync’d to <a href="https://search.maven.org/";>Maven Central</a>
automatically.</p>
+<p>For Maven Central Repository, you can Release from the <a
href="https://repository.apache.org/";>Apache Nexus Repository Manager</a>. This
is already populated by the <code class="language-plaintext
highlighter-rouge">release-build.sh publish-release</code> step. Log in,
+open Staging Repositories, find the one voted on (eg. orgapachespark-1257 for
<a
href="https://repository.apache.org/content/repositories/orgapachespark-1257/";>https://repository.apache.org/content/repositories/orgapachespark-1257/</a>),
+select and click Release and confirm. If successful, it should show up under
<a
href="https://repository.apache.org/content/repositories/releases/org/apache/spark/spark-core_2.11/2.2.1/";>https://repository.apache.org/content/repositories/releases/org/apache/spark/spark-core_2.11/2.2.1/</a>
+and the same under <a
href="https://repository.apache.org/content/groups/maven-staging-group/org/apache/spark/spark-core_2.11/2.2.1/";>https://repository.apache.org/content/groups/maven-staging-group/org/apache/spark/spark-core_2.11/2.2.1/</a>
+(look for the correct release version). After some time this will be
sync’d to <a href="https://search.maven.org/";>Maven Central</a>
automatically.</p>
<h4>Upload to PyPI</h4>
@@ -462,7 +465,8 @@ commit to force synchronization between ASF’s git and
the web site, and al
For some reason synchronization seems to not be reliable for this
repository.</p>
<p>On a related note, make sure the version is marked as released on JIRA. Go
find the release page as above, eg.,
-<code class="language-plaintext
highlighter-rouge">https://issues.apache.org/jira/projects/SPARK/versions/12340295</code>,
and click the “Release” button on the right and enter the release
date.</p>
+<a
href="https://issues.apache.org/jira/projects/SPARK/versions/12340295";><code
class="language-plaintext
highlighter-rouge">https://issues.apache.org/jira/projects/SPARK/versions/12340295</code></a>,
+and click the “Release” button on the right and enter the release
date.</p>
<p>(Generally, this is only for major and minor, but not patch releases) The
contributors list can be automatically generated through
<a
href="https://github.com/apache/spark/blob/branch-1.1/dev/create-release/generate-contributors.py";>this
script</a>.
diff --git a/site/security.html b/site/security.html
index da4b248314..8a5894f805 100644
--- a/site/security.html
+++ b/site/security.html
@@ -393,7 +393,7 @@ than a worker, the execution of code on the master is
nevertheless unexpected.</
<p>Enable authentication on any Spark standalone cluster that is not otherwise
secured
from unwanted access, for example by network-level restrictions. Use <code
class="language-plaintext highlighter-rouge">spark.authenticate</code>
-and related security properties described at
https://spark.apache.org/docs/latest/security.html</p>
+and related security properties described at <a
href="https://spark.apache.org/docs/latest/security.html";>https://spark.apache.org/docs/latest/security.html</a></p>
<p>Credit:</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
