Revising contribution docs (Lombiq Technologies: OCORE-154) #15706

Piedone · 2024-04-09T19:49:57Z

Part of #15029.

Note to reviewers: Also check out my comments below, that help understand the changes. Merge #15708 after this.

…y do

…E-154-contributions-docs

Piedone · 2024-04-09T19:51:00Z

CONTRIBUTING.md

-## Code of conduct
-
-See [CODE-OF-CONDUCT.md](./CODE-OF-CONDUCT.md)
+See [Contributing to Orchard Core](https://docs.orchardcore.net/en/latest/docs/guides/contributing/) on the documentation site.


I moved the content of this page and reworked it to there.

Piedone · 2024-04-09T19:52:58Z

README.md

I reworked this so it doesn't overlap with src/README.md. They were partially overlapping, with conflicting information, but neither had the full picture.

We can't assume if a person will see this or the docs page first, so this now always points to the docs, apart from what's specific to the code and GitHub.

Piedone · 2024-04-09T19:53:26Z

README.md

-The documentation can be accessed under <https://docs.orchardcore.net/>. See [the getting started docs](https://docs.orchardcore.net/en/latest/docs/getting-started/) on how to start using Orchard Core.
-
-You can also run Orchard Core from Docker:
-
-```
-docker run --name orchardcms -p 8080:80 orchardproject/orchardcore-cms-linux:latest
-```
-
-Docker images and parameters can be found at <https://hub.docker.com/u/orchardproject/>. See [our Docker documentation](https://docs.orchardcore.net/en/latest/docs/topics/docker/) for more details, especially if you're new to Docker.


Moved this to the linked test drive page.

Piedone · 2024-04-09T19:53:45Z

README.md

-First, clone the repository using the command `git clone https://github.com/OrchardCMS/OrchardCore.git` and checkout the `main` branch. Then, you have multiple options, see below. And when you're ready, head over to [our contribution guide](CONTRIBUTING.md).
-
-### Command Line
-
-1. Install the latest version of the .NET SDK from this page: <https://dotnet.microsoft.com/download>.
-2. Navigate to `./OrchardCore/src/OrchardCore.Cms.Web`.
-3. Run `dotnet run`.
-4. Open the `http://localhost:5000` URL in your browser.
-
-### Visual Studio
-
-1. Download Visual Studio 2022 (v17.8+) from <https://www.visualstudio.com/downloads>.
-2. Launch the solution by clicking on `OrchardCore.sln`. Give Visual Studio time to restore all missing Nuget packages.
-3. Ensure `OrchardCore.Cms.Web` is set as the startup project. Then run the app.


This is now part of the contribution docs.

Piedone · 2024-04-09T19:54:29Z

src/README.md

-[![Join the chat at https://gitter.im/OrchardCMS/OrchardCore](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/OrchardCMS/OrchardCore?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![BSD-3-Clause License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](https://github.com/OrchardCMS/OrchardCore/blob/master/LICENSE)
-[![Documentation](https://readthedocs.org/projects/orchardcore/badge/)](https://docs.orchardcore.net/)
-[![Crowdin](https://badges.crowdin.net/orchard-core/localized.svg)](https://crowdin.com/project/orchard-core)
-
-## Local communities
-
-中文资源
-
-[![Orchard Core CN 中文讨论组](docs/assets/images/orchard-core-cn-community-logo.png)](https://shang.qq.com/wpa/qunwpa?idkey=48721591a71ee7586316604a7a4ee99d26fd977c6120370a06585085a5936f62)


There are better in the root Readme, displayed on GitHub.

Piedone · 2024-04-09T19:56:30Z

src/README.md

-### Command line
-
- Install the latest version of the .NET SDK from this page <https://dotnet.microsoft.com/download>
- Next, navigate to `D:\OrchardCore\src\OrchardCore.Cms.Web` or wherever your folder is on the commandline in Administrator mode.
- Call `dotnet run`.
- Then open the `http://localhost:5000` URL in your browser.
-
-You can also read the [Code Generation Templates documentation](docs/getting-started/templates/README.md) to create new applications from predefined templates.
-
-### Visual Studio
-
-For more details on the various development tools we recommend for using with Orchard Core check out [the Development Tools documentation page](docs/resources/development-tools/README.md).
-
- Download Visual Studio 2022 (any edition) from <https://www.visualstudio.com/downloads/>.
- Open `OrchardCore.sln` and wait for Visual Studio to restore all Nuget packages.
- Ensure `OrchardCore.Cms.Web` is the startup project and run it.
- Optionally install the [Lombiq Orchard Visual Studio Extension](https://marketplace.visualstudio.com/items?itemName=LombiqVisualStudioExtension.LombiqOrchardVisualStudioExtension) to add some useful utilities to your Visual Studio such as an error log watcher or a dependency injector.
- Optionally install the [code snippets from the Orchard Dojo Library](https://orcharddojo.net/orchard-resources/CoreLibrary/Utilities/VisualStudioSnippets/) to quickly generate code in some common scenarios during module and theme development.
-
-### Docker
-
- Run `docker run --name orchardcms orchardproject/orchardcore-cms-linux:latest`
-
-Docker images and parameters can be found at <https://hub.docker.com/u/orchardproject/>
-


This is now all part of the contribution docs and the test drive page (Docker). Here it wasn't useful, because cloning the full source is not how we want to people to start when building an OC app for themselves. I revised the getting started docs for this too.

Piedone · 2024-04-09T19:57:08Z

src/docs/getting-started/README.md

 ## Create an Orchard Core CMS application

-In Visual Studio, create a new empty .NET Core web application. Ex: `Cms.Web`. Do not check "Place solution and project in the same directory", because later when you create modules and themes you will want them to live alongside the web application within the solution.
+!!! note
+    This guide follows a manual process so you can have a deeper understanding of what's happening. You can also use our [code generation templates](templates/README.md) for a quicker start if you create a brand new application. Check out [this guide](../guides/create-cms-application/README.md).


This overlaps with the create-cms-application page. I wasn't sure how to solve this.

Piedone · 2024-04-09T19:57:21Z

src/docs/getting-started/templates/README.md

-!!! warning
-    Due to a bug in the current published version, the following `dotnet new` commands will require the extra argument `--orchard-version 1.8.2`. For instance, instead of typing `dotnet new occms` use `dotnet new occms --orchard-version 1.8.2`
-


We don't have this bug anymore.

Piedone · 2024-04-09T22:19:19Z

SECURITY.md

Brought this in line with what we actually do, and the contact info used in CONTRIBUTING.md previously.

Piedone · 2024-04-09T23:10:30Z

.github/pull_request_template.md

Here is how this looks:

hyzx86 · 2024-04-22T09:04:57Z

src/docs/guides/contributing/reviewing-pull-requests.md

+## Tips on managing pull requests
+
+- [Here's a list](https://github.com/OrchardCMS/OrchardCore/pulls?q=is%3Apr+is%3Aopen+reviewed-by%3A%40me) of open PRs reviewed by you. Maybe check them because perhaps it's time to ping the authors since maybe they forgot to follow up? Or maybe you forgot to merge a PR? 
+- Add the "don't merge" label on PRs that are ready for review, approved by you and/or others, but you asked more people for feedback before it can be merged.


In reality, contributors are currently unable to add any labels other than "Don't merge" label

Hmm, strange. Could you please send a screenshot of this as you see it?

this is my screen

I see, so you can't actually add any label, strange. I added a note on this.

Yes, and as @hishamco mentioned earlier, it should be possible to specify a member of the review, but I can't do that here

That's unfortunately just how GitHub works.

github-actions · 2024-04-22T16:35:04Z

This pull request has merge conflicts. Please resolve those before requesting a review.

…ibutions-docs # Conflicts: # src/docs/guides/contributing/contributing-documentation.md

MikeAlhayek

I briefly looked at this and it LGTM

README.md

…tributions-docs

Piedone · 2024-04-23T21:52:14Z

Would you like to add anything, @hishamco?

src/README.md

src/docs/guides/contributing/reviewing-pull-requests.md

src/docs/guides/contributing/contributing-code.md

hishamco · 2024-04-23T22:10:51Z

@Piedone please check my review then we can merge

Co-authored-by: Hisham Bin Ateya <hishamco_2007@yahoo.com>

hishamco

LGTM let us merge :)

Piedone · 2024-04-23T22:31:03Z

Thanks for the reviews!

Piedone added 21 commits April 8, 2024 23:15

Facebook is still Facebook, even if owned by Meta

055ea71

Typo

a654036

Adding note about Windows Mkdocs builds

acdf6fe

Updating release publishing workflow with posting that we can actuall…

82f098c

…y do

Moving docs contributions

23bbf44

Removing duplicated link

4a59fa0

Adding contribution docs

713b2d6

Adding PR review docs

7a2d4ef

Adding more code contribution docs

47034d8

Fix unrecognized relative links in the docs

d428c14

Merge remote-tracking branch 'origin/issue/OCORE-155' into issue/OCOR…

dbc40f8

…E-154-contributions-docs

Fixing more links

ab1962f

Merge remote-tracking branch 'origin/issue/OCORE-155' into issue/OCOR…

352319c

…E-154-contributions-docs

Removing outdated warning

fd0d224

Adding test drive docs

281f5c9

Improving contrib docs

b0142b1

Missing menu link

afaf61a

DRYing Readmes

183da0e

Test drive link in Readme

c83e246

Moving contribution guide to /guides

6864541

Note on handling first-time contributors

0a95b7a

Piedone requested a review from agriffard as a code owner April 9, 2024 19:49

Piedone commented Apr 9, 2024

View reviewed changes

SECURITY.md Outdated

Copy link

Member Author

Piedone Apr 9, 2024

Choose a reason for hiding this comment

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

Brought this in line with what we actually do, and the contact info used in CONTRIBUTING.md previously.

Piedone added 3 commits April 10, 2024 00:58

PR comment trick

17feff1

Adding PR template

98cd5a7

Fixing CoC link

9194af5

Piedone commented Apr 9, 2024

View reviewed changes

.github/pull_request_template.md Outdated

Copy link

Member Author

Piedone Apr 9, 2024

Choose a reason for hiding this comment

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

Here is how this looks:

Piedone mentioned this pull request Apr 9, 2024

Get our issue management game in order #15034

Closed

8 tasks

Piedone added 2 commits April 10, 2024 01:22

Adding notes about sorting issues

693e367

More review docs

fe2c935

Piedone mentioned this pull request Apr 16, 2024

Refresh and simplify mkdocs instructions, and fix warnings emitted by mkdocs #15775

Closed

Piedone requested review from hishamco and MikeAlhayek April 16, 2024 20:28

hyzx86 reviewed Apr 22, 2024

View reviewed changes

github-actions bot added the merge conflict label Apr 22, 2024

Piedone added 2 commits April 22, 2024 23:45

Merge remote-tracking branch 'origin/main' into issue/OCORE-154-contr…

0e0c285

…ibutions-docs # Conflicts: # src/docs/guides/contributing/contributing-documentation.md

Adding note for external contributors on reviews

03bd458

github-actions bot removed the merge conflict label Apr 22, 2024

MikeAlhayek approved these changes Apr 23, 2024

View reviewed changes

README.md Show resolved Hide resolved

Merge remote-tracking branch 'official/main' into issue/OCORE-154-con…

23db21e

…tributions-docs

hishamco requested changes Apr 23, 2024

View reviewed changes

Piedone and others added 2 commits April 24, 2024 00:26

Typos/grammar

e5d29cb

Co-authored-by: Hisham Bin Ateya <hishamco_2007@yahoo.com>

More grammar

a3a68dc

Co-authored-by: Hisham Bin Ateya <hishamco_2007@yahoo.com>

Piedone requested a review from hishamco April 23, 2024 22:27

hishamco approved these changes Apr 23, 2024

View reviewed changes

Piedone merged commit ecf9f0d into OrchardCMS:main Apr 23, 2024
6 checks passed

This was referenced May 1, 2024

Monthly community metrics report for 2024-04-01..2024-04-30 #15929

Closed

Monthly community metrics report for 2024-04-01..2024-04-30 Emmanjr/OrchardCore#2

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revising contribution docs (Lombiq Technologies: OCORE-154) #15706

Revising contribution docs (Lombiq Technologies: OCORE-154) #15706

Piedone commented Apr 9, 2024 •

edited

Loading

Piedone Apr 9, 2024

Piedone Apr 9, 2024

Piedone Apr 9, 2024

Piedone Apr 9, 2024

Piedone Apr 9, 2024

Piedone Apr 9, 2024

Piedone Apr 9, 2024

Piedone Apr 9, 2024

Piedone Apr 9, 2024

Piedone Apr 9, 2024

hyzx86 Apr 22, 2024

Piedone Apr 22, 2024

hyzx86 Apr 22, 2024

Piedone Apr 22, 2024

hyzx86 Apr 23, 2024

Piedone Apr 23, 2024

github-actions bot commented Apr 22, 2024

MikeAlhayek left a comment

Piedone commented Apr 23, 2024

hishamco commented Apr 23, 2024

hishamco left a comment

Piedone commented Apr 23, 2024

		!!! warning
		Due to a bug in the current published version, the following `dotnet new` commands will require the extra argument `--orchard-version 1.8.2`. For instance, instead of typing `dotnet new occms` use `dotnet new occms --orchard-version 1.8.2`

Revising contribution docs (Lombiq Technologies: OCORE-154) #15706

Revising contribution docs (Lombiq Technologies: OCORE-154) #15706

Conversation

Piedone commented Apr 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Apr 22, 2024

MikeAlhayek left a comment

Choose a reason for hiding this comment

Piedone commented Apr 23, 2024

hishamco commented Apr 23, 2024

hishamco left a comment

Choose a reason for hiding this comment

Piedone commented Apr 23, 2024

Piedone commented Apr 9, 2024 •

edited

Loading