Skip to content

Fixed broken links in Contributing docs #7114

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 26, 2025
Merged

Fixed broken links in Contributing docs #7114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions contributing/backoffice-project/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,3 @@ We are using a tool called Web Test Runner which spins up a bunch of browsers us

Working with playwright: [https://playwright.dev/docs/intro](https://playwright.dev/docs/intro)

## Putting it all together

When we are finished with the dashboard we will hopefully have something akin to this [real-world example of the actual dashboard that was migrated](https://github.com/umbraco/Umbraco.CMS.Backoffice/tree/main/src/backoffice/settings/dashboards/published-status).
2 changes: 1 addition & 1 deletion contributing/documentation/getting-started/how-to-add-a-new-version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The documentation is versioned using directories in the root of the repository.
{% hint style="info" %}
The documentation follows the Long Term Support (LTS) strategy for Umbraco CMS. This means that whenever a major version is End of Life (EOL), documentation for that version will be moved to GitHub.

Read the [Versioning Strategy](../../documentation-and-versions.md) article to learn more about how to handle documentation for the different versions.
Read the [Versioning Strategy](https://docs.umbraco.com/welcome/documentation-and-versions) article to learn more about how to handle documentation for the different versions.
{% endhint %}

The following sections of the Umbraco Documentation are following the versioning strategy:
Expand Down
2 changes: 1 addition & 1 deletion contributing/ui-library/components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Umbraco UI components

- 🛠️ - WIP in [`./src/components`](https://github.com/umbraco/Umbraco.UI/tree/dev/src/components)
- 🛠️ - WIP in `./src/components`

Check failure on line 3 in contributing/ui-library/components.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.Acronyms] 'WIP' has no definition

Raw Output:
{"message": "[UmbracoDocs.Acronyms] 'WIP' has no definition", "location": {"path": "contributing/ui-library/components.md", "range": {"start": {"line": 3, "column": 8}}}, "severity": "ERROR"}
- 📦 - released
- without emoji - untouched idea

Expand Down
6 changes: 3 additions & 3 deletions contributing/ui-library/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

If you're not sure, leave a note on your contribution and we will be happy to guide you.

When your contribution has been accepted, it will be [MIT licensed](https://github.com/umbraco/Umbraco.UI/blob/dev/LICENSE) from that time onwards.
When your contribution has been accepted, it will be [MIT licensed](https://github.com/umbraco/Umbraco.UI/blob/4392ef990688b9717e7851eace128fecfeb2a85f/LICENSE) from that time onwards.

Check failure on line 25 in contributing/ui-library/contributing.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.Acronyms] 'MIT' has no definition

Raw Output:
{"message": "[UmbracoDocs.Acronyms] 'MIT' has no definition", "location": {"path": "contributing/ui-library/contributing.md", "range": {"start": {"line": 25, "column": 55}}}, "severity": "ERROR"}

### What can I start with?

Expand All @@ -44,7 +44,7 @@

### Development Guide

The UI Library components are [web components](https://developer.mozilla.org/en-US/docs/Web/Web\_Components) built with [Lit](https://lit.dev/) and Typescript. Lit is a light-weight base class that makes development of web components easier and handles all the necessary things, attaching shadow root, reactivity, attribute reflection etc. We strongly encourage you to take a look at Lit documentation before starting development.
The UI Library components are [web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) built with [Lit](https://lit.dev/) and Typescript. Lit is a light-weight base class that makes development of web components easier and handles all the necessary things, attaching shadow root, reactivity, attribute reflection etc. We strongly encourage you to take a look at Lit documentation before starting development.

Check warning on line 47 in contributing/ui-library/contributing.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).

Raw Output:
{"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words).", "location": {"path": "contributing/ui-library/contributing.md", "range": {"start": {"line": 47, "column": 160}}}, "severity": "WARNING"}

Check warning on line 47 in contributing/ui-library/contributing.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[UmbracoDocs.Names] We prefer TypeScript over 'Typescript'

Raw Output:
{"message": "[UmbracoDocs.Names] We prefer TypeScript over 'Typescript'", "location": {"path": "contributing/ui-library/contributing.md", "range": {"start": {"line": 47, "column": 148}}}, "severity": "WARNING"}

Using Typescript is mandatory when contributing to this repository, although it is not necessary to use it when consuming the components.

Expand All @@ -57,7 +57,7 @@

#### New component

You can create a new component and that way contribute to the UI library. But before you do that, go to the [`./src/components`](https://github.com/umbraco/Umbraco.UI/tree/dev/src/components) and check if it's not already there. Components from that folder are very much WIP will be gradually moved to packages. You may also look for an inspiration in this [components list](components.md), where you can check what component is in what stage.
You can create a new component and that way contribute to the UI library. But before you do that, go to the [packages](https://github.com/umbraco/Umbraco.UI/tree/main/packages) folder and check if it's not already there. You can also look at the [Components list](components.md) for an inspiration, where you can check what component is in what stage.

**Package anatomy**

Expand Down
8 changes: 2 additions & 6 deletions contributing/umbraco-cms/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,7 @@ In order to use Umbraco as a CMS and build your website with it, you should not

If the answer is yes, please read on. Otherwise, make sure to head on over [to the download page](https://our.umbraco.com/download) and start using Umbraco CMS as intended.

## Table of contents

↖️ You can jump to any section by using the "table of contents" button ( ![Table of contents icon](img/tableofcontentsicon.svg) ) above.

## Getting Started:
## Getting Started

To run umbraco, we first need to initialize the client git submodule:

Expand Down Expand Up @@ -93,7 +89,7 @@ In order to build the Umbraco source code locally with Visual Studio, first make
* [Visual Studio 2022 v17+ with .NET 7+](https://visualstudio.microsoft.com/vs/) ([the community edition is free](https://www.visualstudio.com/thank-you-downloading-visual-studio/?sku=Community\&rel=15) for you to use to contribute to Open Source projects)
* [Node.js v14+](https://nodejs.org/en/download/)
* npm v7+ (installed with Node.js)
* [Git command line](https://git-scm.com/download/)
* [Git command line](https://git-scm.com/downloads)

The easiest way to get started is to open `umbraco.sln` in Visual Studio.

Expand Down
2 changes: 1 addition & 1 deletion contributing/umbraco-cms/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The following steps are a quick-start guide:

On GitHub, in your forked repository (`https://github.com/[YourUsername]/Umbraco-CMS`) you will see a banner saying that you pushed a new branch and a button to make a pull request. Tap the button and follow the instructions.

Want to read further? [Creating a pull request and what happens next](creating-a-pr/).
Want to read further? [Creating a pull request and what happens next](creating-a-pr.md).

{% hint style="info" %}
If you encounter errors while building the project, make sure you're using the latest supported versions of Node.js and npm.
Expand Down
Loading