Add Codespaces capability to contribute to the site#691
Add Codespaces capability to contribute to the site#691janiceilene merged 7 commits intogithub:mainfrom ojacques:codespaces
Conversation
|
Thanks so much for this @ojacques ✨ I'll get this triaged for review! |
janiceilene
added
contributing docs
|
This looks good to me! @janiceilene, @simpsoka, if the two of you approve this PR from a Product perspective, I'll get it merged. |
janiceilene
added
the
hacktoberfest-accepted
|
This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit. |
github-actions
Bot
added
the
stale
|
Thanks for opening this @ojacques! Added some quick suggestions to the contributing guide for you. 💖 |
Co-authored-by: Kathy Korevec <simpsoka@github.com>
|
@simpsoka, took your comments into account. This is ready for your review. |
github-actions
Bot
removed
the
stale
|
|
||
| In a matter of minutes, you will be ready to edit, preview and test your changes directly from the comfort of your browser. | ||
|
|
||
|  |
There was a problem hiding this comment.
One last one @ojacques, would you mind removing the image from here too, to keep things consistent? Once that's done, I'll get this merged! Thank you so much for helping our Codespaces users get set up 🚀
There was a problem hiding this comment.
@janiceilene - done. It became a really small PR eventually 😄. Simple is beautiful.
There was a problem hiding this comment.
Thanks so much for iterating with us @ojacques!
|
There was one conflict with some updates made in https://github.com/github/docs/pull/984/files, so I resolved that and I'll get this merged once tests are passing 🍏 Thanks again @ojacques 🎉 |
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. |
The example is about, creating multi-dimensional distributed hypertable across all data nodes, partitioned along `time` and `location`. Fixes:timescale/docs#688
5 participants
Why:
This PR adds the capability to contribute to GitHub docs using GitHub codespaces.
Two clicks, and you are off contributing with a fully configured environment directly from the comfort of your browser!
Gets you to:
Note: this capability is only visible if your GitHub account has access to GitHub codespaces (which is, at the time of writing, in beta).
What's being changed:
The change impacts
CONTRIBUTING.mdanddevelopment/development.md. It does not impact the actual documentation.The intent is to offer a very simple way to contribute to the documentation, without having to install anything on your MAC/PC.
Check off the following: