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

[OUDS] Add 'Getting Started > Contribute' page and fix some /blob/vx.y.z-ouds-web broken links #2646

Merged

Conversation

julien-deramond
Copy link
Member

@julien-deramond julien-deramond commented Jul 24, 2024

Related issues

Listed in #2589

Description

This PR adds the "Getting Started > Contribute" page based on:

Please note that this PR also fixes some broken links discovered while implementing this page. These were due to the specific naming of OUDS Web tags that have a "-ouds-web" suffix.

Types of change

  • New feature (non-breaking change which adds functionality)

Live previews

@julien-deramond julien-deramond added docs Improvements or additions to documentation no squash labels Jul 24, 2024
@julien-deramond julien-deramond added this to the OUDS milestone Jul 24, 2024
Copy link

netlify bot commented Jul 24, 2024

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 6615943
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/66a0fadc7d062500091fd0d7
😎 Deploy Preview https://deploy-preview-2646--boosted.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.

@julien-deramond julien-deramond changed the title [OUDS] Add 'Getting Started > Contribute' page and fix some /blob/vx.y.z-ouds-web broken links [OUDS] Add 'Getting Started > Contribute' page and fix some /blob/vx.y.z-ouds-web broken links Jul 24, 2024
Copy link
Member

@louismaximepiton louismaximepiton left a comment

Choose a reason for hiding this comment

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

Some Bootstrap tweaks to do but LGTM 🚀

@@ -22,7 +22,7 @@ OUDS Web is maintained by the core team and a small group of invaluable core con
</div>
{{< /team.inline >}}

Get involved with OUDS Web development by [opening an issue]({{< param repo >}}/issues/new/choose) or submitting a pull request. Read our [contributing guidelines]({{< param repo >}}/blob/v{{< param current_version >}}/.github/CONTRIBUTING.md) for information on how we develop.
Get involved with OUDS Web development by [opening an issue]({{< param repo >}}/issues/new/choose) or submitting a pull request. Read our [contributing guidelines]({{< param repo >}}/blob/v{{< param current_version >}}-ouds-web/.github/CONTRIBUTING.md) for information on how we develop.
Copy link
Member

Choose a reason for hiding this comment

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

[BS side] It would make more sense if it was the main linked to it directly imo.

{{< callout-soon "page" >}}
## Tooling setup

OUDS Web uses [npm scripts](https://docs.npmjs.com/misc/scripts/) to build the documentation and compile source files. Our [package.json]({{< param repo >}}/blob/v{{< param current_version >}}-ouds-web/package.json) houses these scripts for compiling code, running tests, and more. These aren't intended for use outside our repository and documentation.
Copy link
Member

Choose a reason for hiding this comment

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

[BS side] Same on this page (but not all) as well since we are cloning main most of the time, check all the files before submitting a PR down there.


OUDS Web uses [Autoprefixer](https://github.com/postcss/autoprefixer) (included in our build process) to automatically add vendor prefixes to some CSS properties at build time. Doing so saves us time and code by allowing us to write key parts of our CSS a single time while eliminating the need for vendor mixins.

We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See [.browserslistrc]({{< param repo >}}/blob/v{{< param current_version >}}-ouds-web/.browserslistrc) for details.
Copy link
Member

Choose a reason for hiding this comment

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

[BS side]

Suggested change
We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See [.browserslistrc]({{< param repo >}}/blob/v{{< param current_version >}}-ouds-web/.browserslistrc) for details.
We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See [`.browserslistrc`]({{< param repo >}}/blob/v{{< param current_version >}}-ouds-web/.browserslistrc) for details.

@julien-deramond julien-deramond force-pushed the ouds/main-jd-add-getting-started-conttribute-page branch from f52b3ae to 6615943 Compare July 24, 2024 13:00
@julien-deramond julien-deramond merged commit bc21eed into ouds/main Jul 24, 2024
11 of 12 checks passed
@julien-deramond julien-deramond deleted the ouds/main-jd-add-getting-started-conttribute-page branch July 24, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation no squash
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants