This is an automated email from the ASF dual-hosted git repository. warren pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit a56aeaf38b2f4413da832a3bfcd601b2b2927aec Author: yumengwang03 <[email protected]> AuthorDate: Tue May 31 01:56:28 2022 +0800 docs: updated homepage and other docs --- community/Team/_category_.json | 4 + community/Team/team.md | 88 ++++++++++++++++++++++ community/contributor/_category_.json | 4 - community/contributor/contributors.md | 63 ---------------- community/make-contribution/BlogSubmission.md | 6 +- .../contributor-growth-program.md | 5 ++ .../make-contribution/development-workflow.md | 4 + .../make-contribution/fix-or-create-issues.md | 6 +- community/subscribe.md | 26 +++++++ docs/01-Overview/01-WhatIsDevLake.md | 4 +- docs/08-Dashboards/AverageRequirementLeadTime.md | 9 +++ docs/08-Dashboards/CommitCountByAuthor.md | 9 +++ docs/08-Dashboards/DetailedBugInfo.md | 9 +++ docs/08-Dashboards/GitHubBasic.md | 9 +++ .../GitHubReleaseQualityAndContributionAnalysis.md | 9 +++ docs/08-Dashboards/Jenkins.md | 9 +++ docs/08-Dashboards/WeeklyBugRetro.md | 9 +++ docs/08-Dashboards/_category_.json | 4 + docs/08-LiveDemo.md | 35 --------- docusaurus.config.js | 53 ++++++++----- src/components/HomepageFeatures.js | 6 +- src/css/custom.css | 8 ++ 22 files changed, 249 insertions(+), 130 deletions(-) diff --git a/community/Team/_category_.json b/community/Team/_category_.json new file mode 100644 index 0000000..20e6b9f --- /dev/null +++ b/community/Team/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Team", + "position": 3 +} diff --git a/community/Team/team.md b/community/Team/team.md new file mode 100644 index 0000000..cf5d780 --- /dev/null +++ b/community/Team/team.md @@ -0,0 +1,88 @@ +--- +sidebar_position: 01 +title: "Team" +--- +# Team + +## PPMC +- [Klesh Wong](https://github.com/klesh) +- [Julien Chinapen](https://github.com/e2corporation) +- [Liang Zhang](https://github.com/mindlesscloud) +- [Yingchu Chen](https://github.com/warren830) +- [Jonathan O'Donnell](https://github.com/joncodo) +- [Hezheng Yin](https://github.com/hezyin) +- [Maxim Wheatley](https://github.com/MaximDub) + +## Committers +- [Kaiyun (Louis) Zhang](https://github.com/startrekzky) +- [Jinglei Ren](https://github.com/basicthinker) +- [Jingyang Liang](https://github.com/liangjingyang) +- [Zhicheng Jiang](https://github.com/mappjzc) +- [Zikuan An](https://github.com/abeizn) +- [Yumeng Wang](https://github.com/yumengwang03) +- [Yanghui Lin](https://github.com/likyh) +- [Hao Ke](https://github.com/KeHaohaoke) +- [Cong (Narro) Wang](https://github.com/narrowizard) +- [Jinxiu (Jax) Zhou](https://github.com/jaxzhou) + + +## Contributors + +All DevLake contributors will be awarded with a certificate once their first PRs +get merged into the codebase. We deeply appreciate your contribution! + +### New Contributors May 2022 + +#### Jiageng Li + +--- + + + +#### Xiangyu Zhang + +--- + + + +#### Xiaolei Wang + +--- + + + +#### Peng Su + +--- + + + +#### Dunyu Song + +--- + + + +#### Nikita Koselev + +--- + + + +#### Shimin An + +--- + + + +#### Abhishek KM + +--- + + + +#### Guiping Tan + +--- + + \ No newline at end of file diff --git a/community/contributor/_category_.json b/community/contributor/_category_.json deleted file mode 100644 index c07fe12..0000000 --- a/community/contributor/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Contributors", - "position": 3 -} diff --git a/community/contributor/contributors.md b/community/contributor/contributors.md deleted file mode 100644 index 5c5c25e..0000000 --- a/community/contributor/contributors.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -sidebar_position: 1 ---- - -# DevLake Contributors -> All DevLake contributors will receive a certificate once their first PRs -get merged into the codebase. We really appreciate your contribution! - -## New Contributors in 2022 May - -### Jiageng Li - ---- - - - -### Xiangyu Zhang - ---- - - - -### Xiaolei Wang - ---- - - - -### Peng Su - ---- - - - -### Dunyu Song - ---- - - - -### Nikita Koselev - ---- - - - -### Shimin An - ---- - - - -### Abhishek KM - ---- - - - -### Guiping Tan - ---- - - \ No newline at end of file diff --git a/community/make-contribution/BlogSubmission.md b/community/make-contribution/BlogSubmission.md index 55bc252..88530ab 100644 --- a/community/make-contribution/BlogSubmission.md +++ b/community/make-contribution/BlogSubmission.md @@ -1,8 +1,6 @@ --- sidebar_position: 02 -title: "How to Submit a Blog?" -linkTitle: "How to Submit a Blog?" -tags: [] +title: "Blog Submission" description: > Instructions for how to submit a blog post to DevLake Blog --- @@ -26,7 +24,7 @@ Notice: No matter if you are submitting blog posts in one or two languages, plea ```markdown warren: - name: Warren Chen (陈映初) + name: Warren Chen title: DevLake Contributor url: https://github.com/warren830 image_url: https://github.com/warren830.png diff --git a/community/make-contribution/contributor-growth-program.md b/community/make-contribution/contributor-growth-program.md index 8a43299..765e930 100644 --- a/community/make-contribution/contributor-growth-program.md +++ b/community/make-contribution/contributor-growth-program.md @@ -1,3 +1,8 @@ +--- +sidebar_position: 04 +title: "Contributor Growth Program" +--- + # Contributor Growth Program **Note:** This document is wip and welcomes everyone to help improve. diff --git a/community/make-contribution/development-workflow.md b/community/make-contribution/development-workflow.md index bbd3e48..290de7f 100644 --- a/community/make-contribution/development-workflow.md +++ b/community/make-contribution/development-workflow.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 03 +title: "Development Workflow" +--- # Development Workflow This document shows the workflow of how to develop DevLake. diff --git a/community/make-contribution/fix-or-create-issues.md b/community/make-contribution/fix-or-create-issues.md index fca873c..8cfce72 100644 --- a/community/make-contribution/fix-or-create-issues.md +++ b/community/make-contribution/fix-or-create-issues.md @@ -1,4 +1,8 @@ -# Contribute to issues +--- +sidebar_position: 02 +title: "Contributing to Issues" +--- +# Contributing to Issues > @Klesh Last week(2022-05-12), we had 2 designated Good First Issues listed out for everyone diff --git a/community/subscribe.md b/community/subscribe.md new file mode 100644 index 0000000..b691854 --- /dev/null +++ b/community/subscribe.md @@ -0,0 +1,26 @@ +--- +sidebar_position: 04 +title: "Mailing List" +--- + +# Mailing List + +## Subscribe to Mailing List + +We highly recommend that you subscribe to the development mailing list of Apache Devlake (Incubating) to keep up and participate in the latest community discussions. + +**Please note: you will need to subscribe to the mailing list first before participating in any discussions.** + +### Steps +1. Send an e-mail to [[email protected]](mailto:[email protected]) with an arbitrary subject and content from your own e-mail address. +2. Receive an confirmation e-mail from [[email protected]}(mailto:[email protected]) and follow the instruction to reply. The subject and content of the reply e-mail are also arbitrary. (If you have not received the confirmation e-mail, try checking your spam inbox.) +3. Recevie a welcome e-mail and you will start receiving e-mails from [[email protected]](mailto:[email protected]). + +## Unsubscribe from Mailing List + +Although we are incredibly reluctant to see you go, but we respect your choice if you would like to unsubscribe from the mailing list. + +### Steps +1. Send an e-mail to [[email protected]](mailto:[email protected]) with an arbitrary subject and content from your subscribed e-mail address. +2. Receive an confirmation e-mail from [[email protected]}(mailto:[email protected]) and follow the instruction to reply. The subject and content of the reply e-mail are also arbitrary. (If you have not received the confirmation e-mail, try checking your spam inbox.) +3. Receive a goodbye e-mail and you will no longer receive e-mails from [[email protected]](mailto:[email protected]). \ No newline at end of file diff --git a/docs/01-Overview/01-WhatIsDevLake.md b/docs/01-Overview/01-WhatIsDevLake.md index 8b787ad..1449c30 100755 --- a/docs/01-Overview/01-WhatIsDevLake.md +++ b/docs/01-Overview/01-WhatIsDevLake.md @@ -10,8 +10,8 @@ Apache DevLake is designed for developer teams looking to make better sense of t ## What can be accomplished with Apache DevLake? 1. Collect DevOps data across the entire Software Development Life Cycle (SDLC) and connect the siloed data with a standard [data model](../05-DataModels/01-DevLakeDomainLayerSchema.md). -2. Visualize out-of-the-box engineering [metrics](../06-EngineeringMetrics.md) on many dashboards. -3. Create custom analyzes of your DevOps data with a flexible [framework](02-Architecture.md) for data collection and ETL. +2. Visualize out-of-the-box engineering [metrics](../06-EngineeringMetrics.md in a series of use-case driven dashboards +3. Easily extend DevLake to support your data sources, metrics, and dashboards with a flexible [framework](02-Architecture.md) for data collection and ETL. <div align="left"> diff --git a/docs/08-Dashboards/AverageRequirementLeadTime.md b/docs/08-Dashboards/AverageRequirementLeadTime.md new file mode 100644 index 0000000..0710335 --- /dev/null +++ b/docs/08-Dashboards/AverageRequirementLeadTime.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 6 +title: "Average Requirement Lead Time by Assignee" +description: > + DevLake Live Demo +--- + +# Average Requirement Lead Time by Assignee +<iframe src="https://grafana-lake.demo.devlake.io/d/q27fk7cnk/demo-average-requirement-lead-time-by-assignee?orgId=1&from=1635945684845&to=1651584084846"; width="100%" height="940px"></iframe> \ No newline at end of file diff --git a/docs/08-Dashboards/CommitCountByAuthor.md b/docs/08-Dashboards/CommitCountByAuthor.md new file mode 100644 index 0000000..04e029c --- /dev/null +++ b/docs/08-Dashboards/CommitCountByAuthor.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 2 +title: "Commit Count by Author" +description: > + DevLake Live Demo +--- + +# Commit Count by Author +<iframe src="https://grafana-lake.demo.devlake.io/d/F0iYknc7z/demo-commit-count-by-author?orgId=1&from=1634911190615&to=1650635990615"; width="100%" height="820px"></iframe> diff --git a/docs/08-Dashboards/DetailedBugInfo.md b/docs/08-Dashboards/DetailedBugInfo.md new file mode 100644 index 0000000..b777617 --- /dev/null +++ b/docs/08-Dashboards/DetailedBugInfo.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 4 +title: "Detailed Bug Info" +description: > + DevLake Live Demo +--- + +# Detailed Bug Info +<iframe src="https://grafana-lake.demo.devlake.io/d/s48Lzn5nz/demo-detailed-bug-info?orgId=1&from=1635945709579&to=1651584109579"; width="100%" height="800px"></iframe> \ No newline at end of file diff --git a/docs/08-Dashboards/GitHubBasic.md b/docs/08-Dashboards/GitHubBasic.md new file mode 100644 index 0000000..7ea28cd --- /dev/null +++ b/docs/08-Dashboards/GitHubBasic.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 1 +title: "GitHub Basic Metrics" +description: > + DevLake Live Demo +--- + +# GitHub Basic Metrics +<iframe src="https://grafana-lake.demo.devlake.io/d/KXWvOFQnz/github_basic_metrics?orgId=1&from=1635945132339&to=1651583532339"; width="100%" height="3080px"></iframe> \ No newline at end of file diff --git a/docs/08-Dashboards/GitHubReleaseQualityAndContributionAnalysis.md b/docs/08-Dashboards/GitHubReleaseQualityAndContributionAnalysis.md new file mode 100644 index 0000000..61db78f --- /dev/null +++ b/docs/08-Dashboards/GitHubReleaseQualityAndContributionAnalysis.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 5 +title: "GitHub Release Quality and Contribution Analysis" +description: > + DevLake Live Demo +--- + +# GitHub Release Quality and Contribution Analysis +<iframe src="https://grafana-lake.demo.devlake.io/d/2xuOaQUnk1/github_release_quality_and_contribution_analysis?orgId=1&from=1635945847658&to=1651584247658"; width="100%" height="2800px"></iframe> \ No newline at end of file diff --git a/docs/08-Dashboards/Jenkins.md b/docs/08-Dashboards/Jenkins.md new file mode 100644 index 0000000..506a3c9 --- /dev/null +++ b/docs/08-Dashboards/Jenkins.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 7 +title: "Jenkins" +description: > + DevLake Live Demo +--- + +# Jenkins +<iframe src="https://grafana-lake.demo.devlake.io/d/W8AiDFQnk/jenkins?orgId=1&from=1635945337632&to=1651583737632"; width="100%" height="1060px"></iframe> \ No newline at end of file diff --git a/docs/08-Dashboards/WeeklyBugRetro.md b/docs/08-Dashboards/WeeklyBugRetro.md new file mode 100644 index 0000000..adbc4e8 --- /dev/null +++ b/docs/08-Dashboards/WeeklyBugRetro.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 3 +title: "Weekly Bug Retro" +description: > + DevLake Live Demo +--- + +# Weekly Bug Retro +<iframe src="https://grafana-lake.demo.devlake.io/d/-5EKA5w7k/weekly-bug-retro?orgId=1&from=1635945873174&to=1651584273174"; width="100%" height="2240px"></iframe> diff --git a/docs/08-Dashboards/_category_.json b/docs/08-Dashboards/_category_.json new file mode 100644 index 0000000..a15002e --- /dev/null +++ b/docs/08-Dashboards/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Dashboards (Live Demo)", + "position": 8 +} diff --git a/docs/08-LiveDemo.md b/docs/08-LiveDemo.md deleted file mode 100644 index 23963d7..0000000 --- a/docs/08-LiveDemo.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -sidebar_position: 08 -title: "Dashboards (Live Demo)" -linkTitle: "Live Demo" -tags: [] -categories: [] -weight: 7 -description: > - DevLake Live Demo ---- - -## Basic Dashboards - -### GitHub Basic Dashboard -<iframe src="https://grafana-lake.demo.devlake.io/d/KXWvOFQnz/github_basic_metrics?orgId=1&from=1635945132339&to=1651583532339"; width="100%" height="3080px"></iframe> - -### Jenkins Basic Dashboard -<iframe src="https://grafana-lake.demo.devlake.io/d/W8AiDFQnk/jenkins?orgId=1&from=1635945337632&to=1651583737632"; width="100%" height="1060px"></iframe> - -## Advanced Dashboards - -### Commit Count by Author -<iframe src="https://grafana-lake.demo.devlake.io/d/F0iYknc7z/demo-commit-count-by-author?orgId=1&from=1634911190615&to=1650635990615"; width="100%" height="820px"></iframe> - -### Weekly Bug Retro -<iframe src="https://grafana-lake.demo.devlake.io/d/-5EKA5w7k/weekly-bug-retro?orgId=1&from=1635945873174&to=1651584273174"; width="100%" height="1860px"></iframe> - -### Detailed Bug Info -<iframe src="https://grafana-lake.demo.devlake.io/d/s48Lzn5nz/demo-detailed-bug-info?orgId=1&from=1635945709579&to=1651584109579"; width="100%" height="800px"></iframe> - -### GitHub Release Quality and Contribution Analysis -<iframe src="https://grafana-lake.demo.devlake.io/d/2xuOaQUnk1/github_release_quality_and_contribution_analysis?orgId=1&from=1635945847658&to=1651584247658"; width="100%" height="2800px"></iframe> - -### Average Requirement Lead Time by Assignee -<iframe src="https://grafana-lake.demo.devlake.io/d/q27fk7cnk/demo-average-requirement-lead-time-by-assignee?orgId=1&from=1635945684845&to=1651584084846"; width="100%" height="940px"></iframe> \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 38ae443..c8a5f2f 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -30,8 +30,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); readingTime: ({content, frontMatter, defaultReadingTime}) => defaultReadingTime({content, options: {wordsPerMinute: 300}}), // Please change this to your repo. - editUrl: - undefined, + editUrl: 'https://github.com/apache/incubator-devlake-website/edit/main', blogSidebarTitle: 'All posts', blogSidebarCount: 'ALL', }, @@ -89,14 +88,12 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); label: 'Community', docsPluginId: 'community' }, - {to: '/blog', label: 'Blog', position: 'right'}, { - href: 'https://github.com/apache/incubator-devlake/graphs/contributors', - label: 'Team', - position: 'right', - }, + to: '/blog', + label: 'Blog', + position: 'right'}, { - href: 'https://github.com/merico-dev/lake', + to: 'https://github.com/apache/incubator-devlake', label: 'GitHub', position: 'right', }, @@ -107,23 +104,27 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); items: [ { label: 'Foundation', - href: 'https://www.apache.org/', + to: 'https://www.apache.org/', }, { label: 'License', - href: 'https://www.apache.org/licenses/', - }, + to: 'https://www.apache.org/licenses/', + }, + { + label: 'Events', + to: 'https://www.apache.org/events/', + }, { label: 'Security', - href: 'https://www.apache.org/security/', + to: 'https://www.apache.org/security/', }, { label: 'Sponsorship', - href: 'https://www.apache.org/foundation/sponsorship.html', + to: 'https://www.apache.org/foundation/sponsorship.html', }, { label: 'Thanks', - href: 'https://www.apache.org/foundation/thanks.html', + to: 'https://www.apache.org/foundation/thanks.html', } ], }, @@ -140,8 +141,20 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); title: 'Docs', items: [ { - label: 'Docs', - to: '/docs/Overview/WhatIsDevLake', + label: 'Quick Start', + to: 'docs/QuickStart/LocalSetup', + }, + { + label: 'Data Models', + to: 'docs/DataModels/DevLakeDomainLayerScheema', + }, + { + label: 'Engineering Metrics', + to: 'docs/EngineeringMetrics', + }, + { + label: 'Dashboards (Live Demo)', + to: 'docs/Dashboards/GitHubBasic', }, ], }, @@ -150,7 +163,11 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); items: [ { label: 'Slack', - href: 'https://join.slack.com/t/devlake-io/shared_invite/zt-17b6vuvps-x98pqseoUagM7EAmKC82xQ', + to: 'https://join.slack.com/t/devlake-io/shared_invite/zt-17b6vuvps-x98pqseoUagM7EAmKC82xQ', + }, + { + label: 'GitHub Issue Tracker', + to: 'https://github.com/apache/incubator-devlake/issues', }, ], }, @@ -159,7 +176,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); items: [ { label: 'GitHub', - href: 'https://github.com/merico-dev/lake', + to: 'https://github.com/apache/incubator-devlake', }, ], }, diff --git a/src/components/HomepageFeatures.js b/src/components/HomepageFeatures.js index 3ef8d18..5bdfa41 100644 --- a/src/components/HomepageFeatures.js +++ b/src/components/HomepageFeatures.js @@ -8,7 +8,7 @@ const FeatureList = [ Svg: require('../../static/img/SilosConnected.svg').default, description: ( <> - Collect DevOps data across the entire SDLC and connect siloed data with a standard data model + Collect DevOps data across the entire Software Development LifeCycle (SDLC) and connect siloed data with a standard data model </> ), }, @@ -17,7 +17,7 @@ const FeatureList = [ Svg: require('../../static/img/OutoftheboxAnalysis.svg').default, description: ( <> - Provide out-of-the-box engineering metrics to be visualized in a sereis of dashboards + Visualize out-of-the-box engineering metrics in a series of use-case driven dashboards </> ), }, @@ -26,7 +26,7 @@ const FeatureList = [ Svg: require('../../static/img/HighlyFlexible.svg').default, description: ( <> - Flexible framework for data collection and ETL, support customized analysis + Easily extend DevLake to support your data sources, metrics, and dashboards </> ), }, diff --git a/src/css/custom.css b/src/css/custom.css index 8702b55..1a74aa8 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -26,3 +26,11 @@ html[data-theme='dark'] .docusaurus-highlight-code-line { background-color: rgba(0, 0, 0, 0.3); } + +html[data-theme='light'] footer { + background-color: 292B3F; +} + +html[data-theme='light'] .theme-doc-footer-edit-meta-row { + background-color: white; +}
