HDDS-10449. Add quick start to the top of contributing guide. #83
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
website-v2
|
Hi @errose28 thank you for the patch. May I ask do we need to fork the ozone-site repository beforehand (just like the main ozone repo)? |
…ting-guide * HDDS-9225-website-v2: HDDS-10254. Add GitHub Actions check for Markdown style. (apache#81)
|
Thanks for checking this out @ivandika3. Yes fork and PR workflow for this repo is the same as the main Ozone repo but I think the original quick start I wrote did not make this clear. I've updated it to reference the main Ozone contributing guide rather than re-write all of that here. Let me know if it looks better now. |
ivandika3
approved these changes
Mar 5, 2024
swagle
approved these changes
Mar 26, 2024
|
Thanks @swagle and @ivandika3 for the reviews. I was hoping to get more eyes on this, but for now lets merge it with the existing approvals so more contributors can see it. If more clarifications are needed they can easily be done in follow ups. |
errose28
added a commit
to errose28/ozone-site
that referenced
this pull request
May 30, 2024
* HDDS-9225-website-v2: Bump docusaurus to 3.3.2 (apache#93) HDDS-10667. Improvements to spelling checks. (apache#89) HDDS-10698. Bump skywalking-eyes to v0.6.0 (apache#90) HDDS-10449. Add quick start to the top of contributing guide. (apache#83) HDDS-10351. Add GitHub Actions check for yaml formatting (apache#87) HDDS-9567. Add GitHub Actions license header check for relevant files. (apache#86) HDDS-10506. Reduce directory iterations in sidebar check (apache#85) HDDS-9866. Add GitHub Actions checks for consistent Docusaurus formatting. (apache#84) HDDS-10254. Add GitHub Actions check for Markdown style. (apache#81) HDDS-10349. Add GitHub Actions check for consistent file name formatting. (apache#79) HDDS-10426. Crop ozone-logo.svg to a proper size (apache#80) HDDS-10353. Add GitHub Actions check of all generated URLs in the sitemap. (apache#77) HDDS-9868. Add GitHub Actions check for spelling. (apache#76) HDDS-10400. Fix event condition in website publish workflow (apache#78) HDDS-10352. Add GitHub Actions workflow to build and run the website. (apache#74) HDDS-10222. Add pnpm guide to contributing guide. (apache#64) HDDS-10313. Update "Redundant" to "Reliable" in new website. (apache#73)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
The contributing guide has become quite dense. While it is good to have the inner workings and best practices of the website documented, the structure of the doc may confusing to new users. Add a quick start guide to the top to get them up and running quickly.
Thanks @swagle for the suggestion.
What is the link to the Apache Jira?
HDDS-10449
How was this patch tested?
Manually tested by cloning the website to a fresh directory and following the added steps.