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 api docs into GitHub pages #122

Closed
4 tasks
GuySartorelli opened this issue Sep 4, 2024 · 1 comment
Closed
4 tasks

Move api docs into GitHub pages #122

GuySartorelli opened this issue Sep 4, 2024 · 1 comment
Assignees

Comments

@GuySartorelli
Copy link
Member

GuySartorelli commented Sep 4, 2024

The API docs are a bunch of static files generated on a cron.

Right now we're hosting them on silverstripe cloud, despite this not being a Silverstripe CMS site. Which is silly.

We should move the API docs into GitHub pages and set them up to rebuild every x amount of time via a GitHub Actions cron.

Acceptance Criteria

  • api.silverstripe.org is hosted on GitHub Pages
  • The search functionality used by API links in the docs is retained as closely as sensibly possible
  • The site can be built manually, is build when the master branch is pushed, and is built on a cron
  • After hosting is swapped over, the old stack in Silverstripe Cloud is removed

API doc PR

After merging, reassign to Guy to set up GitHub Pages here and organise swapping hosting over.

PRs for after hosting has swapped over

This PR MUST NOT be merged until API docs hosting has swapped over.

@GuySartorelli
Copy link
Member Author

Not doing this anymore. New card will be created with the preferred alternative.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant