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

🌐 Update deployment documentation to clarify deployment types #1262

Merged
merged 7 commits into from
Aug 8, 2024

Conversation

agoose77
Copy link
Contributor

@agoose77 agoose77 commented May 30, 2024

This PR attempts to clarify the different ways that a MyST site can be deployed (and why you'd pick one over the other).

Closes #927

There's more to cover here, such as deploying a MyST server to Vercel, but I think this is a good start for our JB MVP docs.

@agoose77 agoose77 marked this pull request as ready for review May 30, 2024 16:15
@agoose77 agoose77 closed this May 31, 2024
@agoose77 agoose77 reopened this May 31, 2024
@agoose77 agoose77 requested a review from rowanc1 June 4, 2024 14:50
@agoose77 agoose77 closed this Jun 10, 2024
@agoose77 agoose77 reopened this Jun 10, 2024
@agoose77 agoose77 changed the title 💻 Update deployment documentation to clarify deployment types 🌐 Update deployment documentation to clarify deployment types Jun 24, 2024
@rowanc1 rowanc1 self-assigned this Jun 25, 2024
@rowanc1
Copy link
Collaborator

rowanc1 commented Jun 25, 2024

Can I take a look at this over this week please!

@agoose77 agoose77 added the blocked Waiting for another task to be compled label Jul 17, 2024
@agoose77
Copy link
Contributor Author

@rowanc1 are you able to prioritise this over the next two weeks?

Copy link
Collaborator

@choldgraf choldgraf left a comment

Choose a reason for hiding this comment

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

I think this is a nice improvement on what is there, so I'd be +1 on merging it, though we need to improve these docs as options grow for users to deploy MyST. I think we should link to a Curvenote guide on deploying MyST (or write a short guide in these docs similar to what we have with netlify etc), as well as a similar one for Vercel.

I made a few suggested changes. In particular I suggest we call it MyST Applications rather than Dynamic sites with MyST since the static sites are still plenty dynamic, and I don't want to confuse people into thinking that interactivity is gone just because it's static HTML.

docs/deployment.md Outdated Show resolved Hide resolved
docs/deployment.md Outdated Show resolved Hide resolved
docs/deployment.md Outdated Show resolved Hide resolved
docs/deployment.md Outdated Show resolved Hide resolved
Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu>
Copy link

changeset-bot bot commented Aug 8, 2024

⚠️ No Changeset found

Latest commit: 6b94762

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

agoose77 and others added 3 commits August 8, 2024 11:18
Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu>
Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu>
Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu>
@agoose77
Copy link
Contributor Author

agoose77 commented Aug 8, 2024

@choldgraf we're in a space with such a large set of overloaded terms that any attempt to disambiguate things is a good one. Thanks for these changes!

docs/deployment.md Outdated Show resolved Hide resolved
@rowanc1 rowanc1 removed the blocked Waiting for another task to be compled label Aug 8, 2024
@rowanc1 rowanc1 changed the title 🌐 Update deployment documentation to clarify deployment types 🌐 Update deployment documentation to clarify deployment types Aug 8, 2024
@rowanc1 rowanc1 merged commit 98d87a5 into main Aug 8, 2024
4 of 7 checks passed
@rowanc1 rowanc1 deleted the agoose77/docs-static-vs-dynamic-server branch August 8, 2024 18:15
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.

Clarify the options for static site hosting and "live server" hosting
3 participants