Skip to content

Commit

Permalink
chore: migrate very_good_docs_site (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
alestiago committed Feb 19, 2024
1 parent cd03b2d commit 62e1724
Show file tree
Hide file tree
Showing 45 changed files with 1,071 additions and 1 deletion.
63 changes: 63 additions & 0 deletions .github/workflows/very_good_docs_site.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: very_good_docs_site

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

on:
push:
paths:
- .github/workflows/very_good_docs_site.yaml
- "very_good_docs_site/**"
branches:
- main
pull_request:
paths:
- .github/workflows/very_good_docs_site.yaml
- "very_good_docs_site/**"
branches:
- main

jobs:
brick:
runs-on: ubuntu-latest

steps:
- name: 📚 Git Checkout
uses: actions/checkout@v4

- name: 🎯 Setup Dart
uses: dart-lang/setup-dart@v1
with:
sdk: stable

- name: 🧱 Mason Make
run: |
dart pub global activate mason_cli
mason get
mason make very_good_docs_site -c very_good_docs_site/config.json -o output --on-conflict overwrite
- name: ⚙️ Setup Node
uses: actions/setup-node@v4
with:
node-version: 18.x

- name: 📦 Install Dependencies
run: |
cd output/test_docs_site
npm i
- name: ✨ Check Format
run: |
cd output/test_docs_site
npm run format:check
- name: 🧹 Lint
run: |
cd output/test_docs_site
npm run lint
- name: 👷 Build website
run: |
cd output/test_docs_site
npm run build
4 changes: 3 additions & 1 deletion mason.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ bricks:
very_good_dart_package:
path: very_good_dart_package
very_good_flutter_package:
path: very_good_flutter_package
path: very_good_flutter_package
very_good_docs_site:
path: very_good_docs_site
7 changes: 7 additions & 0 deletions very_good_docs_site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Files and directories created by mason
.mason/
mason-lock.json
output/

# Files and directories created by MacOS
.DS_Store
42 changes: 42 additions & 0 deletions very_good_docs_site/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# 0.0.2

- build(deps-dev): bump @tsconfig/docusaurus in /src/very_good_docs_site ([#135](https://github.com/VeryGoodOpenSource/very_good_docs_site/pull/135))
- chore: generate template ([#136](https://github.com/VeryGoodOpenSource/very_good_docs_site/pull/136))
- build(deps): bump @docusaurus/core in /src/very_good_docs_site ([#140](https://github.com/VeryGoodOpenSource/very_good_docs_site/pull/140))
- build(deps): bump @docusaurus/preset-classic in /src/very_good_docs_site ([#137](https://github.com/VeryGoodOpenSource/very_good_docs_site/pull/137))
- build(deps): bump actions/setup-node from 3 to 4 ([#145](https://github.com/VeryGoodOpenSource/very_good_docs_site/pull/145))
- chore: request code ownership ([#147](https://github.com/VeryGoodOpenSource/very_good_docs_site/pull/147))
- feat: update to docusaurs 3.0 ([#152](https://github.com/VeryGoodOpenSource/very_good_docs_site/pull/152))
- refactor: remove generator script ([#162](https://github.com/VeryGoodOpenSource/very_good_docs_site/pull/162))

# 0.0.1+7

- build(deps): various dependency updates

# 0.0.1+6

- build(deps): various dependency updates

# 0.0.1+5

- build(deps): various dependency updates

# 0.0.1+4

- build(deps): various dependency updates

# 0.0.1+3

- build(deps): upgrade to docusaurus 2.2.0

# 0.0.1+2

- refactor: use npm

# 0.0.1+1

- build(deps): upgrade lockfile

# 0.0.1

- feat: initial release 🎉
32 changes: 32 additions & 0 deletions very_good_docs_site/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to Very Good Docs Site

First off, thanks for taking the time to contribute! 🎉👍

This project is opinionated and follows patterns and practices used by the team at [Very Good Ventures][very_good_ventures_link]. **At this time, we welcome bug tickets but will not be accepting feature requests because the roadmap and scope of this project is still being defined.** In the future, we may support additional, more feature-rich templates but at this time we would ask that issues be reserved for bugs only.

## Creating a Bug Report

We highly recommend [creating an issue][bug_report_link] if you have found a bug rather than immediately opening a pull request. This lets us reach an agreement on a fix before you put significant effort into a pull request. Please use the built-in [Bug Report][bug_report_link] template and provide as much information as possible including detailed reproduction steps. Once one of the package maintainers has reviewed the issue and an agreement is reached regarding the fix, a pull request can be created.

## Creating a Pull Request

Before creating a pull request please:

1. Fork the repository and create your branch from `main`.
1. Install all dependencies (`dart pub get`).
1. Squash your commits and ensure you have a meaningful, [semantic][conventional_commits_link] commit message.
1. Add tests! Pull Requests without 100% test coverage will not be approved.
1. Ensure the existing test suite passes locally.
1. Format your code (`dart format .`).
1. Analyze your code (`dart analyze --fatal-infos --fatal-warnings .`).
1. Create the Pull Request.
1. Verify that all status checks are passing.

While the prerequisites above must be satisfied prior to having your
pull request reviewed, the reviewer(s) may ask you to complete additional
work, tests, or other changes before your pull request can be ultimately
accepted.

[conventional_commits_link]: https://www.conventionalcommits.org/en/v1.0.0
[bug_report_link]: https://github.com/VeryGoodOpenSource/dart_frog/issues/new?assignees=&labels=bug&template=bug_report.md&title=fix%3A+
[very_good_ventures_link]: https://verygood.ventures
21 changes: 21 additions & 0 deletions very_good_docs_site/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Very Good Ventures

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
80 changes: 80 additions & 0 deletions very_good_docs_site/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Very Good Docs Site

[![Very Good Ventures][logo_white]][very_good_ventures_link_dark]

Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄

[![License: MIT][license_badge]][license_link]
[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)

A Very Good documentation site template powered by [Docusaurus][docusaurus_link] created by Very Good Ventures 🦄.

## What's Included ✨

- ✅ GitHub Workflow
- ✅ Pull Request Template
- ✅ Issue Templates
- ✅ Dependabot Integration
- ✅ Light/Dark Mode
- ✅ Landing Page
- ✅ Docs powered by Markdown
- ✅ Customizable Theming
- ✅ MIT License

## Output 📦

```sh
├── .eslintrc.js
├── .github
│   ├── ISSUE_TEMPLATE
│   │   ├── bug_report.md
│   │   ├── build.md
│   │   ├── chore.md
│   │   ├── ci.md
│   │   ├── config.yml
│   │   ├── documentation.md
│   │   ├── feature_request.md
│   │   ├── performance.md
│   │   ├── refactor.md
│   │   ├── revert.md
│   │   ├── style.md
│   │   └── test.md
│   ├── PULL_REQUEST_TEMPLATE.md
│   ├── dependabot.yml
│   └── workflows
│   └── main.yaml
├── .gitignore
├── .prettierignore
├── .prettierrc
├── README.md
├── babel.config.js
├── docs
│   └── overview.md
├── docusaurus.config.js
├── package.json
├── sidebars.js
├── src
│   ├── css
│   │   └── custom.css
│   └── pages
│   ├── index.module.css
│   └── index.tsx
├── static
│   ├── .nojekyll
│   └── img
│   ├── hero.svg
│   ├── hero_dark.svg
│   ├── logo.svg
│   ├── pillar1.svg
│   ├── pillar2.svg
│   └── pillar3.svg
├── tsconfig.json
└── yarn.lock
```

[docusaurus_link]: https://docusaurus.io
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license_link]: https://opensource.org/licenses/MIT
[logo_white]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_white.png#gh-dark-mode-only
[very_good_ventures_link_dark]: https://verygood.ventures#gh-dark-mode-only
[very_good_ventures_link]: https://verygood.ventures
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
/**
* @type {import('@types/eslint').Linter.BaseConfig}
*/
module.exports = {
extends: ['plugin:@docusaurus/recommended'],
plugins: ['@docusaurus'],
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
},
parser: '@babel/eslint-parser',
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug Report
about: Create a report to help us improve
title: 'fix: '
labels: bug
---

**Description**

A clear and concise description of what the bug is.

**Steps To Reproduce**

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected Behavior**

A clear and concise description of what you expected to happen.

**Screenshots**

If applicable, add screenshots to help explain your problem.

**Additional Context**

Add any other context about the problem here.
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Build System
about: Changes that affect the build system or external dependencies
title: 'build: '
labels: build
---

**Description**

Describe what changes need to be done to the build system and why.

**Requirements**

- [ ] The build system is passing
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Chore
about: Other changes that don't modify src or test files
title: 'chore: '
labels: chore
---

**Description**

Clearly describe what change is needed and why. If this changes code then please use another issue type.

**Requirements**

- [ ] No functional changes to the code
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Continuous Integration
about: Changes to the CI configuration files and scripts
title: 'ci: '
labels: ci
---

**Description**

Describe what changes need to be done to the ci/cd system and why.

**Requirements**

- [ ] The ci system is passing
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Documentation
about: Improve the documentation so all collaborators have a common understanding
title: 'docs: '
labels: documentation
---

**Description**

Clearly describe what documentation you are looking to add or improve.

**Requirements**

- [ ] Requirements go here
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Feature Request
about: A new feature to be added to the project
title: 'feat: '
labels: feature
---

**Description**

Clearly describe what you are looking to add. The more context the better.

**Requirements**

- [ ] Checklist of requirements to be fulfilled

**Additional Context**

Add any other context or screenshots about the feature request go here.
Loading

0 comments on commit 62e1724

Please sign in to comment.