feat: Improved dashboard documentation and gitignore

serverless · Sep 21, 2023 · 3bbbc58 · 3bbbc58
1 parent c5b6e41
commit 3bbbc58
Show file tree

Hide file tree

Showing 71 changed files with 457 additions and 2,066 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.github/.DS_Store b/.github/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,5 @@
 npm-debug.log
 /package-lock.json
 /yarn.lock
+**/.DS_Store
+**/.env
diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/guides/dashboard.md b/docs/guides/dashboard.md
diff --git a/docs/guides/cicd/README.md → docs/guides/dashboard/cicd/README.md b/docs/guides/cicd/README.md → docs/guides/dashboard/cicd/README.md
@@ -1,7 +1,7 @@
 <!--
-title: Serverless Dashboard - CI/CD
+title: Serverless Framework Dashboard - CI/CD
 menuText: CI/CD
-menuOrder: 5
+menuOrder: 6
 layout: Doc
 -->
 

diff --git a/docs/guides/cicd/best-practices.md → docs/guides/dashboard/cicd/best-practices.md b/docs/guides/cicd/best-practices.md → docs/guides/dashboard/cicd/best-practices.md
diff --git a/docs/guides/cicd/branch-deployments.md → ...ides/dashboard/cicd/branch-deployments.md b/docs/guides/cicd/branch-deployments.md → ...ides/dashboard/cicd/branch-deployments.md
diff --git a/docs/guides/cicd/custom-scripts.md → docs/guides/dashboard/cicd/custom-scripts.md b/docs/guides/cicd/custom-scripts.md → docs/guides/dashboard/cicd/custom-scripts.md
diff --git a/docs/guides/cicd/faq.md → docs/guides/dashboard/cicd/faq.md b/docs/guides/cicd/faq.md → docs/guides/dashboard/cicd/faq.md
diff --git a/docs/guides/cicd/mono-repo.md → docs/guides/dashboard/cicd/mono-repo.md b/docs/guides/cicd/mono-repo.md → docs/guides/dashboard/cicd/mono-repo.md
diff --git a/docs/guides/dashboard/cicd/notifications.md b/docs/guides/dashboard/cicd/notifications.md
@@ -0,0 +1,29 @@
+<!--
+title: Serverless Dashboard - CI/CD Notifications
+menuText: Notifications
+menuOrder: 6
+layout: Doc
+-->
+
+<!-- DOCS-SITE-LINK:START automatically generated  -->
+
+### [Read this on the main serverless docs site](https://serverless.com/framework/docs/guides/cicd/notifications/)
+
+<!-- DOCS-SITE-LINK:END -->
+
+# Notifications
+
+Serverless Framework has integrated Slack, email, SNS and webhook notifications for CI/CD status updates.
+
+Notifications for CI/CD events are not setup by default, so you will not get notified of deployments starting,
+completing of failing. These notifications must be added manually.
+
+Notifications for CI/CD events are configured the same way as they are for [monitoring](/framework/docs/dashboard/monitoring/notifications/).
+
+You can subscribe to three different CI/CD events in the "Add notifications" dialog:
+
+- deployment started
+- deployment succeeded
+- deployment failed
+
+These three events apply to both branch deployments and preview deployments.
diff --git a/docs/guides/cicd/preview-deployments.md → ...des/dashboard/cicd/preview-deployments.md b/docs/guides/cicd/preview-deployments.md → ...des/dashboard/cicd/preview-deployments.md
diff --git a/docs/guides/cicd/private-packages.md → ...guides/dashboard/cicd/private-packages.md b/docs/guides/cicd/private-packages.md → ...guides/dashboard/cicd/private-packages.md
diff --git a/docs/guides/cicd/running-in-your-own-cicd.md → ...ashboard/cicd/running-in-your-own-cicd.md b/docs/guides/cicd/running-in-your-own-cicd.md → ...ashboard/cicd/running-in-your-own-cicd.md
diff --git a/docs/guides/cicd/running-tests.md → docs/guides/dashboard/cicd/running-tests.md b/docs/guides/cicd/running-tests.md → docs/guides/dashboard/cicd/running-tests.md
diff --git a/docs/guides/cicd/troubleshooting.md → .../guides/dashboard/cicd/troubleshooting.md b/docs/guides/cicd/troubleshooting.md → .../guides/dashboard/cicd/troubleshooting.md
diff --git a/docs/guides/orgs.md → docs/guides/dashboard/concepts.md b/docs/guides/orgs.md → docs/guides/dashboard/concepts.md
@@ -1,8 +1,8 @@
 <!--
-title: Serverless Framework - Orgs & Members
-menuText: Serverless Orgs & Members
-menuOrder: 12
-description: Orgs & Members in Serverless Framework Dashboard
+title: Serverless Framework Dashboard - Concepts
+menuText: Concepts
+menuOrder: 2
+description: The Concepts within Serverless Framework Dashboard
 layout: Doc
 -->