diff --git a/contributing/backoffice-project/contributing.md b/contributing/backoffice-project/contributing.md index 67bc21140eb..94d7cbdb5fb 100644 --- a/contributing/backoffice-project/contributing.md +++ b/contributing/backoffice-project/contributing.md @@ -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). diff --git a/contributing/documentation/getting-started/how-to-add-a-new-version.md b/contributing/documentation/getting-started/how-to-add-a-new-version.md index e4624f5b6f9..71e096a7116 100644 --- a/contributing/documentation/getting-started/how-to-add-a-new-version.md +++ b/contributing/documentation/getting-started/how-to-add-a-new-version.md @@ -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: diff --git a/contributing/ui-library/components.md b/contributing/ui-library/components.md index d2cfc2bdc00..6acb2037c4d 100644 --- a/contributing/ui-library/components.md +++ b/contributing/ui-library/components.md @@ -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` - 📦 - released - without emoji - untouched idea diff --git a/contributing/ui-library/contributing.md b/contributing/ui-library/contributing.md index e1e4687ea6f..dd959206bba 100644 --- a/contributing/ui-library/contributing.md +++ b/contributing/ui-library/contributing.md @@ -22,7 +22,7 @@ Similarly, if your contribution is copied or adapted from somewhere else, make s 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. ### What can I start with? @@ -44,7 +44,7 @@ Please follow the pull request template you get provided when creating a pull re ### 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. Using Typescript is mandatory when contributing to this repository, although it is not necessary to use it when consuming the components. @@ -57,7 +57,7 @@ Using Typescript is mandatory when contributing to this repository, although it #### 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** diff --git a/contributing/umbraco-cms/build.md b/contributing/umbraco-cms/build.md index 38d5f8138e1..82e4b094f41 100644 --- a/contributing/umbraco-cms/build.md +++ b/contributing/umbraco-cms/build.md @@ -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: @@ -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. diff --git a/contributing/umbraco-cms/contributing.md b/contributing/umbraco-cms/contributing.md index c1727145ef3..60f3413bca8 100644 --- a/contributing/umbraco-cms/contributing.md +++ b/contributing/umbraco-cms/contributing.md @@ -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.