You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@incubator.apache.org by ti...@apache.org on 2024/02/11 05:14:23 UTC
(apache-website-template) branch docusaurus updated: docs: update README file
This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch docusaurus
in repository https://gitbox.apache.org/repos/asf/apache-website-template.git
The following commit(s) were added to refs/heads/docusaurus by this push:
new f8129ca docs: update README file
f8129ca is described below
commit f8129ca66fdff1c97e0749eb2ed319f1739f6f34
Author: tison <wa...@gmail.com>
AuthorDate: Sun Feb 11 13:14:16 2024 +0800
docs: update README file
Signed-off-by: tison <wa...@gmail.com>
---
README.md | 47 +++++++++++++++++++++--------------------------
1 file changed, 21 insertions(+), 26 deletions(-)
diff --git a/README.md b/README.md
index 0c6c2c2..b413907 100644
--- a/README.md
+++ b/README.md
@@ -1,41 +1,36 @@
-# Website
+# Apache Website Template
-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+This project contains a template website that aims to follow all the various required Apache Website Policies.
-### Installation
+This template was generated using [Docusaurus](https://docusaurus.io/).
-```
-$ yarn
-```
+## Usage
-### Local Development
+You can directly copy from the root path of this template repository to your website repository.
-```
-$ yarn start
-```
+> [!NOTE]
+> TODO: Integrate it with [template support of Docusaurus](https://docusaurus.io/docs/api/misc/create-docusaurus#git-strategy).
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+Most of the configurations are inherited from Docusaurus https://docusaurus.io/docs/configuration.
-### Build
+Specificly, our template defines a few metadata fields to customize for every project:
-```
-$ yarn build
+```typescript
+const projectName = "Template";
+const mainRepoName = "apache-website-template";
+const siteRepoName = "apache-website-template";
```
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+For example, Apache Fury can customize these fields as:
-### Deployment
-
-Using SSH:
-
-```
-$ USE_SSH=true yarn deploy
+```typescript
+const projectName = "Fury";
+const mainRepoName = "incubator-fury";
+const siteRepoName = "incubator-fury-site";
```
-Not using SSH:
+More placeholders and preset are under developed.
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
+## Deploy
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+This template contains [a GitHub Actions workflow](.github/workflows/deploy.yml) to deploy the generated website content to the `asf-site` branch. It would work automatically, without any other ections required.
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@incubator.apache.org
For additional commands, e-mail: cvs-help@incubator.apache.org