(superset) branch master updated: feat(docs): Adds an "Edit this page on GitHub" button to docs pages (#27176)

[ru...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rusackas 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 7e9361fd5f feat(docs): Adds an "Edit this page on GitHub" button to docs pages (#27176)
7e9361fd5f is described below

commit 7e9361fd5f1f9e737cee83257c84de9b7648984a
Author: Evan Rusackas <ev...@preset.io>
AuthorDate: Wed Feb 21 09:24:07 2024 -0700

    feat(docs): Adds an "Edit this page on GitHub" button to docs pages (#27176)
---
 docs/docusaurus.config.js       |  2 +-
 docs/src/styles/main.less       | 10 ++++++++
 docs/src/theme/DocItem/index.js | 57 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 68 insertions(+), 1 deletion(-)

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index d0cc8679d0..d7dc1c931c 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -139,7 +139,7 @@ const config = {
       ({
         docs: {
           sidebarPath: require.resolve('./sidebars.js'),
-          editUrl: 'https://github.com/apache/superset/tree/master/docs',
+          editUrl: 'https://github.com/apache/superset/edit/master/docs',
         },
         blog: {
           showReadingTime: true,
diff --git a/docs/src/styles/main.less b/docs/src/styles/main.less
index d10047fdea..f7d053f9c9 100644
--- a/docs/src/styles/main.less
+++ b/docs/src/styles/main.less
@@ -259,3 +259,13 @@ a > span > svg {
     height: 28px;
   }
 }
+
+/* Edit Button */
+
+.edit-page-link {
+  position: sticky;
+  bottom: 0px;
+  right: 0px;
+  border-radius: 10px;
+  background-color: #ccc;
+}
diff --git a/docs/src/theme/DocItem/index.js b/docs/src/theme/DocItem/index.js
new file mode 100644
index 0000000000..d0852d35b9
--- /dev/null
+++ b/docs/src/theme/DocItem/index.js
@@ -0,0 +1,57 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import React from 'react';
+import styled from '@emotion/styled';
+import DocItem from '@theme-original/DocItem';
+
+const EditPageLink = styled('a')`
+  position: fixed;
+  bottom: 20px;
+  right: 20px;
+  padding: 1rem;
+  padding-left: 4rem;
+  background-color: #444;
+  border-radius: 10px;
+  z-index: 9999;
+  background-image: url('/img/github-dark.png');
+  background-size: 2rem;
+  background-position: 1rem center;
+  background-repeat: no-repeat;
+  transition: background-color 0.3s; /* Smooth transition for hover effect */
+  bpx-shadow: 0 0 0 0 rgba(0,0,0,0); /* Smooth transition for hover effect */
+  scale: .9;
+  transition: all 0.3s;
+
+  &:hover {
+    background-color: #333;
+    box-shadow: 5px 5px 10px 0 rgba(0,0,0,0.3);
+    scale: 1;
+  }
+`;
+
+export default function DocItemWrapper(props) {
+  return (
+    <>
+      <EditPageLink href={props.content.metadata.editUrl} target="_blank" rel="noopener noreferrer">
+        Edit this page on GitHub
+      </EditPageLink>
+      <DocItem {...props} />
+    </>
+  );
+}