Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove docs from monorepo #2517

Merged
merged 3 commits into from
Feb 7, 2022
Merged

Remove docs from monorepo #2517

merged 3 commits into from
Feb 7, 2022

Conversation

jonathantneal
Copy link
Contributor

Changes

  • Removes docs from this project.
  • Docs migrated to https://github.com/withastro/docs
  • Migration notice added to docs directory.
  • References to docs are removed.
  • References to docs are updated in PR template.

Testing

Docs

@changeset-bot
Copy link

changeset-bot bot commented Feb 1, 2022 •
edited
Loading

⚠️ No Changeset found

Latest commit: c76fe81

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added docs 🚨 action Modifies GitHub Actions labels Feb 1, 2022
@FredKSchott
Copy link
Member

LGTM! Grab some time with me and we can go over the netlify update for hosting.

I'm a bit nervous about losing the docs site as a smoke test in this repo. I think I have an idea on how this can work, if you want to pair on updating https://github.com/withastro/astro/blob/main/scripts/smoke/index.js to git clone the docs + www repos.

@jonathantneal jonathantneal force-pushed the jn.remove-docs-from-monorepo branch from 0cd1ac0 to ea0c2ef Compare February 7, 2022 15:23
@jonathantneal
Copy link
Contributor Author

The migration to https://github.com/withastro/docs is complete (Thank you, @FredKSchott). We haven’t changed the smoke tests in this PR, but I would like this merged to prevent further contributions to this now-out-of-date monorepo version the docs.

@Princesseuh
Copy link
Member

Princesseuh commented Feb 7, 2022 •
edited
Loading

In addition to tests, I'm wondering about the benchmarks in packages/astro/test/benchmark, I don't know if we really use them but they're currently setup to build the docs I think? (unless I'm misreading / interpreting the code)

Apart from that, it looks good to my newly-appointed maintainer eyes 😅

@boehs
Copy link
Contributor

boehs commented Feb 7, 2022 •
edited
Loading

Apart from that, it looks good to my newly-appointed maintainer eyes sweat_smile

So lucky! Congrats again @Princesseuh

Re: Pr: lgtm, checks pass

FredKSchott
FredKSchott approved these changes Feb 7, 2022
View reviewed changes
Copy link
Member

@FredKSchott FredKSchott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! After merging, please prioritize updating the smoke tests to use the new external docs repo, since this was an important integration test for us to catch bugs in PRs before merging.

@jonathantneal
Copy link
Contributor Author

Hehe. Just another moment. This now has a merge conflict introduced by #2518. Once it’s resolved, I’m merging this quick. 😄

@jonathantneal jonathantneal force-pushed the jn.remove-docs-from-monorepo branch from b177a95 to c4b7f1c Compare February 7, 2022 17:49
@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) pkg: example Related to an example package (scope) labels Feb 7, 2022
@jonathantneal jonathantneal merged commit a911d14 into main Feb 7, 2022
@jonathantneal jonathantneal deleted the jn.remove-docs-from-monorepo branch February 7, 2022 18:39
SiriousHunter pushed a commit to SiriousHunter/astro that referenced this pull request Feb 3, 2023
@jonathantneal
Remove docs from monorepo (withastro#2517)
9f5dafb 
* Remove docs from monorepo

* Update PULL_REQUEST_TEMPLATE.md

* Update relative doc references with links or todo
SiriousHunter pushed a commit to SiriousHunter/astro that referenced this pull request Feb 3, 2023
@jonathantneal
Remove docs from monorepo (withastro#2517)
df55bd3 
* Remove docs from monorepo

* Update PULL_REQUEST_TEMPLATE.md

* Update relative doc references with links or todo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FredKSchott FredKSchott FredKSchott approved these changes

Assignees
No one assigned
Labels
🚨 action Modifies GitHub Actions pkg: astro Related to the core `astro` package (scope) pkg: example Related to an example package (scope)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jonathantneal @FredKSchott @Princesseuh @boehs