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.

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

Move legacy guides to a separate repository #4459

Merged
merged 4 commits into from
Jul 20, 2022
Merged

Move legacy guides to a separate repository #4459

merged 4 commits into from
Jul 20, 2022

Conversation

aldesantis
Copy link
Member

@aldesantis aldesantis commented Jul 19, 2022

Description

The legacy guides have been moved to https://github.com/solidusio/legacy-guides, because they are going to be replaced by the new guides hosted at https://github.com/solidusio/edgeguides pretty soon.

The https://guides.solidus.io site has been updated to point to the new repository.

Checklist:

  • I have followed Pull Request guidelines
  • I have added a detailed description into each commit message
  • I have updated Guides and README accordingly to this change (if needed)
  • I have added tests to cover this change (if needed)
  • I have attached screenshots to this PR for visual changes (if needed)

@aldesantis
Copy link
Member Author

aldesantis commented Jul 19, 2022

Please note that Netlify checks are only failing because I've moved the build to Cloudflare Pages (since that's where we're managing DNS for solidus.io nowadays).

@aldesantis aldesantis requested a review from a team July 19, 2022 22:09
These have been moved to https://github.com/solidusio/legacy-guides,
because they are going to be replaced by the new guides hosted at
https://github.com/solidusio/edgeguides pretty soon.
Copy link
Contributor

@waiting-for-dev waiting-for-dev left a comment

Choose a reason for hiding this comment

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

Lovely! ❤️

We can use this PR to remove a couple of references to the old guides in /guides:

  1. Stoping CI for guides-only changes.
  2. Ignoring node_modules directory within guides for rubocop.

For 1., we might want to keep it if the new guides will be also placed in guides, although it has some problems (like stopping a build for a multi-commit PR that modifies more than the guides but only the guides in the last commit).

This updates the PR template to follow a slightly more linear structure,
and adjusts a couple of checklist items to account for our new documentation
practices.
@aldesantis
Copy link
Member Author

aldesantis commented Jul 20, 2022

@waiting-for-dev I've addressed your suggested changes, and I have also taken the chance to update the PR template: it now points to the new guides repository.

As for the CI, I have decided against keeping the documentation in this repo: because the new guides are versioned, and the content for all versions is in the same branch (just in different directories), it would lead to a very weird situation where we have the documentation for all Solidus versions in the master branch of solidusio/solidus, which would make it weird to navigate the documentation from GitHub and/or to update the documentation for older versions.

I have explored the possibility of using the solidusio/edgeguides repo just to host the Docusaurus app, and have it read the actual content of the guides from the different branches in solidusio/solidus. It works, but it creates a bunch of additional issues/gotchas with deployments and preview environments. I think it's just too big of a headache at this point, and we can explore alternative solutions in the future.

@aldesantis aldesantis requested a review from a team July 20, 2022 09:26
@aldesantis
Copy link
Member Author

CI failure seems unrelated, merging.

@aldesantis aldesantis merged commit a227230 into solidusio:master Jul 20, 2022
@aldesantis aldesantis deleted the move-legacy-guides branch July 20, 2022 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants