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

docs: add stormkit as deployment platform #10011

Merged
merged 3 commits into from
Apr 5, 2024
Merged

Conversation

eldemcan
Copy link
Contributor

@eldemcan eldemcan commented Apr 3, 2024

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

add stormkit as deployment platform

Test Plan

Test links

Deploy preview: https://deploy-preview-10011--docusaurus-2.netlify.app/docs/deployment/#deploying-to-stormkit

Related issues/PRs

@facebook-github-bot
Copy link
Contributor

Hi @eldemcan!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

Copy link

netlify bot commented Apr 3, 2024

[V2]

Name Link
🔨 Latest commit 4849561
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/660fc7b8a58e200008e33e47
😎 Deploy Preview https://deploy-preview-10011--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

github-actions bot commented Apr 3, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 60 🟢 98 🟢 96 🟢 100 🟠 88 Report
/docs/installation 🟠 66 🟢 96 🟢 100 🟢 100 🟠 88 Report
/docs/category/getting-started 🟠 76 🟢 100 🟢 100 🟢 90 🟠 88 Report
/blog 🟠 70 🟢 100 🟢 100 🟢 90 🟠 88 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 63 🟢 96 🟢 100 🟢 100 🟠 88 Report
/blog/tags/release 🟠 70 🟢 100 🟢 100 🟠 80 🟠 88 Report
/blog/tags 🟠 73 🟢 100 🟢 100 🟢 90 🟠 88 Report

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Apr 4, 2024
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

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

Hi

Our new policy for adding new deployment platforms in this page is to simply link to an external official resource explaining how to deploy Docusaurus to that platform, instead of explaining things in our own docs directly.

This way, we put the burden on the platform owners to ensure their Docusaurus deployment guide remains relevant.

Example: https://deploy-preview-10011--docusaurus-2.netlify.app/docs/deployment/#deploying-to-kinsta

If you are not from Stormkit, or not willing to create such official guide, I'd prefer to close this PR

Comment on lines 818 to 830
## Deploying to Stormkit {#deploying-to-stormkit}

You can deploy your Docusaurus project to Stormkit, a deployment platform for static websites, single-page applications (SPAs), and serverless functions.

- Log in to [Stormkit](https://stormkit.io/).
- Using the user interface, import your Docusaurus project from one of the three supported Git providers (GitHub, GitLab, or Bitbucket).
- Navigate to the project’s production environment in Stormkit or create a new environment if needed.
- Verify the build command in your Stormkit configuration. By default, Stormkit CI will run npm run build but you can specify a custom build command on this page.
- Click the “Deploy Now” button to deploy your site.

Read more in the [Stormkit Documentation](https://stormkit.io/docs/welcome/getting-started).


Copy link
Collaborator

Choose a reason for hiding this comment

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

this is too much text, too detailed , and likely to diverge and get stale over time

@eldemcan
Copy link
Contributor Author

eldemcan commented Apr 4, 2024

Hi

Our new policy for adding new deployment platforms in this page is to simply link to an external official resource explaining how to deploy Docusaurus to that platform, instead of explaining things in our own docs directly.

This way, we put the burden on the platform owners to ensure their Docusaurus deployment guide remains relevant.

Example: https://deploy-preview-10011--docusaurus-2.netlify.app/docs/deployment/#deploying-to-kinsta

If you are not from Stormkit, or not willing to create such official guide, I'd prefer to close this PR

@slorber thanks for your comment. I made changes that you requested. It will be easier for us to maintain as you said.

@eldemcan eldemcan requested a review from slorber April 4, 2024 23:19
Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

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

LGTM thanks 👍

@slorber slorber merged commit 5bb4832 into facebook:main Apr 5, 2024
9 checks passed
@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants