You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ma...@apache.org on 2024/06/18 16:16:20 UTC
(superset) branch master updated: docs: remove comment header in README.md (#29273)
This is an automated email from the ASF dual-hosted git repository.
maximebeauchemin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/master by this push:
new ab7f8ad1bf docs: remove comment header in README.md (#29273)
ab7f8ad1bf is described below
commit ab7f8ad1bfb3f65498688e916cf56734f2bda5b5
Author: Maxime Beauchemin <ma...@gmail.com>
AuthorDate: Tue Jun 18 09:16:14 2024 -0700
docs: remove comment header in README.md (#29273)
---
.rat-excludes | 1 +
README.md | 4 ----
docs/package.json | 4 ++--
docs/src/intro_header.txt | 4 ++++
4 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/.rat-excludes b/.rat-excludes
index 70529a4bd8..7cfb991cc9 100644
--- a/.rat-excludes
+++ b/.rat-excludes
@@ -71,3 +71,4 @@ snowflake.svg
# docs-related
erd.puml
erd.svg
+intro_header.txt
diff --git a/README.md b/README.md
index aab794ec55..408cad422b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,3 @@
----
-hide_title: true
-sidebar_position: 1
----
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
diff --git a/docs/package.json b/docs/package.json
index 5933f8cfa2..102cd80a77 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -5,13 +5,13 @@
"license": "Apache-2.0",
"scripts": {
"docusaurus": "docusaurus",
- "_init": "cp ../README.md docs/intro.md",
+ "_init": "cat src/intro_header.txt ../README.md > docs/intro.md",
"start": "npm run _init && docusaurus start",
"build": "npm run _init && docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
- "serve": "docusaurus serve",
+ "serve": "npm run _init && docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"typecheck": "tsc"
diff --git a/docs/src/intro_header.txt b/docs/src/intro_header.txt
new file mode 100644
index 0000000000..483a5e7dba
--- /dev/null
+++ b/docs/src/intro_header.txt
@@ -0,0 +1,4 @@
+---
+hide_title: true
+sidebar_position: 1
+---