You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@otava.apache.org by as...@apache.org on 2025/03/23 05:18:15 UTC
(otava-website) branch master updated (9eed02d -> 528c417)
This is an automated email from the ASF dual-hosted git repository.
asorokoumov pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/otava-website.git
from 9eed02d Add .asf.yaml
new 6cadfb7 fixup
new 528c417 Update README
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
README.md | 38 +++++++++++---------------------------
docs/overview.md | 2 --
docusaurus.config.ts | 4 ++--
3 files changed, 13 insertions(+), 31 deletions(-)
(otava-website) 02/02: Update README
Posted by as...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
asorokoumov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/otava-website.git
commit 528c417768845eeec64b5f9b4ba21e392b1f487f
Author: Alex Sorokoumov <al...@gmail.com>
AuthorDate: Sat Mar 22 22:18:04 2025 -0700
Update README
---
README.md | 38 +++++++++++---------------------------
1 file changed, 11 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
index b413907..8462273 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,20 @@
-# Apache Website Template
+# Apache Otava Website
-This project contains a template website that aims to follow all the various required Apache Website Policies.
+This project is a website for Apache Otava..
-This template was generated using [Docusaurus](https://docusaurus.io/).
+This website was built using [Docusaurus](https://docusaurus.io/) version of [apache-website-template](https://github.com/apache/apache-website-template/tree/docusaurus).
-## Usage
+## Installation
-You can directly copy from the root path of this template repository to your website repository.
+Run `pnpm install` to install all dependencies.
-> [!NOTE]
-> TODO: Integrate it with [template support of Docusaurus](https://docusaurus.io/docs/api/misc/create-docusaurus#git-strategy).
+Note: Make sure you have installed [pnpm](https://pnpm.io) before running the command.
-Most of the configurations are inherited from Docusaurus https://docusaurus.io/docs/configuration.
+## Dev server
-Specificly, our template defines a few metadata fields to customize for every project:
+Run `pnpm start` for a dev server. Navigate to [http://localhost:3000/](http://localhost:3000/). The application will
+automatically reload if you change any of the source files.
-```typescript
-const projectName = "Template";
-const mainRepoName = "apache-website-template";
-const siteRepoName = "apache-website-template";
-```
+## Build
-For example, Apache Fury can customize these fields as:
-
-```typescript
-const projectName = "Fury";
-const mainRepoName = "incubator-fury";
-const siteRepoName = "incubator-fury-site";
-```
-
-More placeholders and preset are under developed.
-
-## Deploy
-
-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.
+Run pnpm build to build the project.
(otava-website) 01/02: fixup
Posted by as...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
asorokoumov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/otava-website.git
commit 6cadfb72f99c69ac33622af296f828974f6566c8
Author: Alex Sorokoumov <al...@gmail.com>
AuthorDate: Sat Mar 22 22:08:52 2025 -0700
fixup
---
docs/overview.md | 2 --
docusaurus.config.ts | 4 ++--
2 files changed, 2 insertions(+), 4 deletions(-)
diff --git a/docs/overview.md b/docs/overview.md
index 574934c..3e8cf9d 100644
--- a/docs/overview.md
+++ b/docs/overview.md
@@ -17,5 +17,3 @@ sidebar_position: 1
- [BigQuery](big-query.md)
- [CSV](csv.md)
- [Annotating Change Points in Grafana](grafana.md)
-
-This is a demo page for the portal page of documentation. Remember to follow the trademark [policy](https://www.apache.org/foundation/marks/) and [guide](https://www.apache.org/foundation/marks/guide) to provide your content.
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
index 5c51c90..c8946f0 100644
--- a/docusaurus.config.ts
+++ b/docusaurus.config.ts
@@ -50,13 +50,13 @@ const config: Config = {
{
docs: {
sidebarPath: "./docs/sidebars.ts",
- editUrl: `https://github.com/apache/${siteRepoName}/tree/main/`,
+ editUrl: `https://github.com/apache/${siteRepoName}/tree/master/`,
},
blog: {
blogSidebarCount: "ALL",
blogSidebarTitle: "All our posts",
showReadingTime: true,
- editUrl: `https://github.com/apache/${siteRepoName}/tree/main/`,
+ editUrl: `https://github.com/apache/${siteRepoName}/tree/master/`,
},
theme: {
customCss: "./src/css/custom.css",