You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by cc...@apache.org on 2022/02/01 00:53:33 UTC
[incubator-yunikorn-site] branch master updated: [YUNIKORN-1066] Fix website typos (#71)
This is an automated email from the ASF dual-hosted git repository.
ccondit pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new a845a12 [YUNIKORN-1066] Fix website typos (#71)
a845a12 is described below
commit a845a123be7cb9d189fc3f75a53c4876e53f0df7
Author: fredster33 <fr...@slmail.me>
AuthorDate: Mon Jan 31 18:50:38 2022 -0600
[YUNIKORN-1066] Fix website typos (#71)
Closes: #71
---
README.md | 18 +++++++++---------
src/pages/community/how_to_contribute.md | 2 +-
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index c18574a..f36772c 100644
--- a/README.md
+++ b/README.md
@@ -19,11 +19,11 @@
---
![auto-publish](https://github.com/apache/incubator-yunikorn-site/workflows/auto-publish/badge.svg)
-This readme will walk you through building and updating the Apache YuniKorn website
+This README will walk you through building and updating the Apache YuniKorn website.
## Introduction
1. The `master` branch contains the website source code.
-Modifications of the web-site need to be merged into the master branch.
+Modifications of the website need to be merged into the master branch.
2. The `asf-site` branch contains the deployed static pages, scripts and images of the website.
This branch is maintained by `yunikorn-bot`.
@@ -32,28 +32,28 @@ Manually updating this branch should only happen as a last resort.
The website running at https://yunikorn.apache.org will be updated automatically via the configuration set in the `.asf.yaml` file.
## Make changes
-You can build and run the web-site server locally in development mode with the following command:
+You can build and run the website server locally in development mode with the following command:
```shell script
./local-build.sh run
```
-This commands will build a docker image `yunikorn/yunikorn-website:latest` locally, and launch the web-server at URL: [http://localhost:3000](http://localhost:3000)
-The web-site will be built based on the content in the current directory.
-Any changes that are made within the directory will automatically trigger the update of the local web-server.
+This command will build a Docker image `yunikorn/yunikorn-website:latest` locally, and launch the web-server at this URL: [http://localhost:3000](http://localhost:3000)
+The website will be built based on the content in the current directory.
+Any changes that are made within the directory will automatically trigger the update of the local webserver.
You can review your changes from the local endpoint to verify your changes.
-Once the development is done, you need to ctrl+c to exit the script mode.
+Once the development is done, you need to press `Control+C` to exit the script mode.
A build via the script will generate the website in the `build` directory.
The script also allows you to remove all dependencies and installed artefacts.
-This will ensure the next build is a complete clean build like Github Action will run when publishing the site.
+This will ensure the next build is a complete clean build like GitHub Actions will run when publishing the site.
```shell script
./local-build.sh clean
```
## Local build
Instead of running the build inside a docker image you can also run it locally when you have yarn installed.
-This is faster than running the build inside a docker image:
+This is faster than running the build inside a Docker image:
```shell script
yarn install
yarn add @docusaurus/theme-search-algolia
diff --git a/src/pages/community/how_to_contribute.md b/src/pages/community/how_to_contribute.md
index b0a0809..5d9f396 100644
--- a/src/pages/community/how_to_contribute.md
+++ b/src/pages/community/how_to_contribute.md
@@ -27,7 +27,7 @@ under the License.
YuniKorn uses:
* JIRA for issue tracking.
* GitHub Pull Requests to manage code review and the change itself.
-* MarkDown in the source tree for the documentation.
+* Markdown in the source tree for the documentation.
## Find an issue
We use JIRA issues to track bugs for this project.