Skip to content

Conversation

@manutdkid77
Copy link
Contributor

Description

When installing Umbraco Forms on my Umbraco 13 installation, I made the mistake of installing the latest version of umbraco forms when running dotnet add package Umbraco.Forms

As a result, Umbraco Forms was not loading in my backoffice. After searching on Discord and GitHub, I discovered that the issue was due to version incompatibility. I felt sharing this would help others as well.

Please let me know if the note can be improved or changed.

What did you add/update/change?
Added a note about ensuring that the version of Umbraco Forms is compatible with the version of Umbraco being used.

Type of suggestion

  • Typo/grammar fix
  • Updated outdated content
  • New content
  • Updates related to a new version
  • Other

Product & version (if relevant)

Umbraco 10, 13, 14, 15

Copy link
Contributor

@sofietoft sofietoft left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @manutdkid77 !

I think it makes sense to add a note about this to the Forms installation article.
I do think though, that the note should be placed BEFORE you actually add the package. If you read it after the fact, then you will have already run into some issues.

I hope it makes sense!

```
{% hint style="info" %}
**Note:** Ensure that the version of Umbraco Forms is compatible with the version of Umbraco you are using. For example, if you are using Umbraco 10, you should use Umbraco.Forms version 10.5.7 or a compatible version.
Copy link
Contributor

Choose a reason for hiding this comment

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

Made some minor changes, to simplify the wording a bit.

Suggested change
**Note:** Ensure that the version of Umbraco Forms is compatible with the version of Umbraco you are using. For example, if you are using Umbraco 10, you should use Umbraco.Forms version 10.5.7 or a compatible version.
Ensure that the version of Umbraco Forms is compatible with the Umbraco CMS version of your project.
Example: If you are using Umbraco 10, you should the latest version of Umbraco Forms 10.

@manutdkid77
Copy link
Contributor Author

Thank you for reviewing @sofietoft, I definitely agree with your suggestions 😊.

Had a small question, should the note appear as part of step 1, before the dotnet add package command ? or should the note appear before step 1 ?

@sofietoft
Copy link
Contributor

sofietoft commented Jan 21, 2025

Yeah, adding it as part of the steps is actually a great idea!

So, one of the first steps would be to identify which version of Forms to choose.

Something like:

  1. Identify the Umbraco CMS version your project is running.
  2. Run the following command on a command prompt replacing "XX" with the major version identified above:
dotnet add package Umbraco.Forms::XX.*

@manutdkid77
Copy link
Contributor Author

Thank you @sofietoft, can you please check if this is ok ?

1.  Identify the Umbraco CMS version your project is running.
2.  Find a compatible version of Umbraco Forms that matches your Umbraco CMS version. A list of Umbraco Forms versions can be found [here](https://www.nuget.org/packages/Umbraco.Forms#versions-body-tab).
3.  Run the following command in your command prompt, replacing <version_number> with the appropriate version identified above:

    dotnet add package Umbraco.Forms --version <version_number>

4.  Restart the web application using the following command:

     dotnet run

@sofietoft
Copy link
Contributor

Looks great @manutdkid77 ! 💪

Only comment I have is that we don't use "here" for link text, so perhaps say: "can be found on [Nuget.org]" or something similar! 😄

Copy link
Contributor

@sofietoft sofietoft left a comment

Choose a reason for hiding this comment

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

Looks great @manutdkid77 !
Much better adding this as steps to the guide 😁

@sofietoft sofietoft merged commit ec813a1 into umbraco:main Jan 24, 2025
11 of 13 checks passed
@manutdkid77
Copy link
Contributor Author

Thank you @sofietoft for helping out with this PR #h5yr

@manutdkid77 manutdkid77 deleted the umbracoforms/install-tip branch January 24, 2025 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants