Skip to content

Commit

Permalink
Remove docs from monorepo (#2517)
Browse files Browse the repository at this point in the history
* Remove docs from monorepo

* Update PULL_REQUEST_TEMPLATE.md

* Update relative doc references with links or todo
  • Loading branch information
Jonathan Neal committed Feb 7, 2022
1 parent 2bc9154 commit a911d14
Show file tree
Hide file tree
Showing 158 changed files with 20 additions and 15,509 deletions.
1 change: 0 additions & 1 deletion .changeset/pre.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"mode": "pre",
"tag": "next",
"initialVersions": {
"docs": "0.0.7",
"@example/blog": "0.0.1",
"@example/blog-multiple-authors": "0.0.1",
"@example/component": "0.0.1",
Expand Down
5 changes: 3 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@

## Docs

<!-- Was public documentation updated? -->
<!-- DON'T DELETE THIS SECTION! If no docs added, explain why (e.g. "bug fix only") -->
<!-- Did you make a user-facing change? You probably need to update docs! -->
<!-- Add a link to your docs PR here. If no docs added, explain why (e.g. "bug fix only") -->
<!-- Link: https://github.com/withastro/docs -->
11 changes: 0 additions & 11 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,9 @@ example:
'🚨 action':
- .github/workflows/**

docs:
- docs/**

test:
- packages/**/*.test.js

i18n:
- any:
- 'docs/src/pages/*/**'
- '!docs/src/pages/core-concepts/**'
- '!docs/src/pages/guides/**'
- '!docs/src/pages/migration/**'
- '!docs/src/pages/reference/**'

core:
- packages/astro/**

Expand Down
1 change: 0 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ on:
pull_request:
paths-ignore:
- '.vscode/**'
- 'docs/**'
- 'examples/**'

# Automatically cancel in-progress actions on the same branch
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ yarn: "^1.22.10"

### Setting up your local repo

Astro uses yarn workspaces, so you should **always run `yarn install` from the top-level project directory.** running `yarn install` in the top-level project root will install dependencies for `astro`, `docs`, and every package in the repo.
Astro uses yarn workspaces, so you should **always run `yarn install` from the top-level project directory.** running `yarn install` in the top-level project root will install dependencies for `astro`, and every package in the repo.

```shell
git clone && cd ...
Expand Down Expand Up @@ -76,7 +76,7 @@ yarn lint

### Making a Pull Request

When making a pull request, be sure to add a changeset when something has changed with Astro. Non-packages (`examples/*`, `docs/*`) do not need changesets.
When making a pull request, be sure to add a changeset when something has changed with Astro. Non-packages (`examples/*`) do not need changesets.

```shell
yarn changeset
Expand Down Expand Up @@ -145,7 +145,7 @@ To release a snapshot, run the following locally:
# 1:
yarn changeset version --snapshot XXX
# 2: (Manual) review the diff, and make sure that you're not releasing more than you need to.
git checkout -- examples/ docs/
git checkout -- examples/
# 3:
yarn release --tag next--XXX
# 4: (Manual) review the publish, and if you're happy then you can throw out all local changes
Expand Down Expand Up @@ -192,7 +192,7 @@ When in prerelease mode, the automatic PR release process will no longer release
1. Run `yarn changeset version` to create your new release.
1. Run `yarn release` to publish your new release.
1. Run `git push && git push --tags` to push your new release to GitHub.
1. Run `git push release/0.X:latest` to push your release branch to `latest`. This will trigger an update to the docs site, etc.
1. Run `git push release/0.X:latest` to push your release branch to `latest`.
1. Go to https://github.com/withastro/astro/releases/new and create a new release. Copy the new changelog entry from https://github.com/withastro/astro/blob/latest/packages/astro/CHANGELOG.md.
1. Post in Discord #announcements channel, if needed!

Expand Down
1 change: 0 additions & 1 deletion docs/.nvmrc

This file was deleted.

2 changes: 0 additions & 2 deletions docs/.prettierignore

This file was deleted.

7 changes: 0 additions & 7 deletions docs/.prettierrc

This file was deleted.

6 changes: 0 additions & 6 deletions docs/.stackblitzrc

This file was deleted.

55 changes: 0 additions & 55 deletions docs/CHANGELOG.md

This file was deleted.

25 changes: 2 additions & 23 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,3 @@
# Astro Docs <img width="19.2" height="25.6" src="https://raw.githubusercontent.com/withastro/astro/main/assets/brand/logo.svg" alt="Astro logo">
# Astro Docs

## Contributing

### Pull Requests

Every pull request needs to be reviewed by another contributor to the documentation to help with the overall quality of the documentation.

## Running this project

- Clone the Project

`git clone [email protected]:withastro/astro.git`
- Run `yarn install` to install latest dependencies.
> This project uses yarn to manage dependencies. [Make sure that you have yarn v1 installed.](https://classic.yarnpkg.com/)
- Run `yarn workspace docs dev` to start the dev server.
- Run `yarn workspace docs build` to build the final site for production.
> The environment variable `SNOWPACK_PUBLIC_GITHUB_TOKEN` must be set to a personal access token with `public_repo` permissions to prevent rate-limiting.
## Deploying

The site is automatically deployed when commits land in `latest`, via Netlify.

The "next" docs are automatically deployed when commits land in `main`, via Netlify at <https://main--astro-docs-2.netlify.app/getting-started/>.
**⚠️ The Astro docs are now managed at https://github.com/withastro/docs ⚠️**
12 changes: 0 additions & 12 deletions docs/astro.config.mjs

This file was deleted.

8 changes: 0 additions & 8 deletions docs/jsconfig.json

This file was deleted.

32 changes: 0 additions & 32 deletions docs/package.json

This file was deleted.

101 changes: 0 additions & 101 deletions docs/public/code.css

This file was deleted.

Binary file removed docs/public/default-og-image.png
Binary file not shown.
Binary file removed docs/public/favicon.ico
Binary file not shown.
11 changes: 0 additions & 11 deletions docs/public/favicon.svg

This file was deleted.

Loading

0 comments on commit a911d14

Please sign in to comment.