Skip to content

Umbraco Commerce store setup docs #6848

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

Merged
merged 51 commits into from
Mar 19, 2025
Merged

Umbraco Commerce store setup docs #6848

merged 51 commits into from
Mar 19, 2025

Conversation

acoumb
Copy link
Contributor

@acoumb acoumb commented Feb 4, 2025

Description

Documentation on setting up a store in Umbraco Commerce and common use cases documented using this demo store.

This is a draft version awaiting review from @mattbrailsford .

Type of suggestion

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

Product & version (if relevant)

Deadline (if relevant)

Pending review

@acoumb acoumb requested a review from mattbrailsford February 4, 2025 14:06
@eshanrnh eshanrnh added review/developer Use this label if an internal developer review is required category/umbraco-commerce labels Feb 17, 2025
@mattbrailsford
Copy link
Contributor

@eshanrnh It's proving hard to review this directly from the markdown, I'd really like to see it in the actual docs site. Is that something we can do? or, if not, can we just merge it and I have a task on my todo list to review the docs structure etc anyway so could just come and cleanup anything I think needs cleaning up.

@sofietoft
Copy link
Contributor

Hi @mattbrailsford and @acoumb !

You can preview the changes using the link the box just below the comments here.
image

However, all new articles will need to be added to the SUMMARY.md file first, otherwise they will not show up in the published docs or on GitBook.

Hope it makes sense!
We really don't want to merge something that hasn't been reviewed, so this will be a last resort.

@mattbrailsford
Copy link
Contributor

Hmm, I'm not seeing that option
image

@mattbrailsford
Copy link
Contributor

mattbrailsford commented Feb 25, 2025

Ahh, never mind, looks like you can also just click the GitBook heading

image

@mattbrailsford
Copy link
Contributor

@acoumb can you make sure the SUMMARY.md file is updated with links to these new sections such that they show up in the preview 👍

@acoumb
Copy link
Contributor Author

acoumb commented Mar 10, 2025

@acoumb can you make sure the SUMMARY.md file is updated with links to these new sections such that they show up in the preview 👍

@mattbrailsford summary updated

@mattbrailsford
Copy link
Contributor

@acoumb something isn't right here as all your other changes have gone. Also, if you have steps broken down into sub pages, these also need adding to the SUMMARY page.

@acoumb
Copy link
Contributor Author

acoumb commented Mar 11, 2025

Indeed, I've reverted them some weeks ago when I added some UI Builder release notes. Taking care of this now.

@acoumb
Copy link
Contributor Author

acoumb commented Mar 11, 2025

@mattbrailsford it should be alright now. Summary points to the setup store overview where all links are listed.

@mattbrailsford
Copy link
Contributor

Something still isn't right as the links on the first overview page aren't working https://docs.umbraco.com/umbraco-commerce/~/revisions/DqkqRGXUWsFxB3DlbBoY/tutorials/overview-1

I believe that only pages listed in the SUMMARY.md file get deployed so you would need to list the pages as sub pages to the Store Setup entry, otherwise they won't get deployed.

@acoumb
Copy link
Contributor Author

acoumb commented Mar 11, 2025

@mattbrailsford summary updated

@sofietoft
Copy link
Contributor

Thanks @mattbrailsford (and happy birthday 🥳 )

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.

Guides and tutorial looks great.

It would be great if you could add file names to the code snippets.
There are quite a few snippets throughout the guides and the steps in the tutorial, and it is not always clear which file the code should go into.
So, for consistency I suggest that file names are added to each code snippet.

It can be done by wrapping the code snippets like this:

{% code title="filenamehere.cs" %}

```csharp
//this is a code snippet.
```

{% endcode %}

I can do some, probably most, but there are some instances were I wouldn't know which file name to add.

@mattbrailsford
Copy link
Contributor

@sofietoft that should be everything addressed 👍

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 @mattbrailsford ! 👏

I'll get this merged.

@sofietoft
Copy link
Contributor

Let me know when we're ready @mattbrailsford !

I'll add the redirects after this is merged.

@mattbrailsford
Copy link
Contributor

@sofietoft Should be good to go now. I just spotted a few class attributes on some of the code snippets which I removed everywhere else to keep the snippets focused on the main code. But that should be everything now so all good to merge.

@sofietoft sofietoft merged commit 7c70f8a into umbraco:main Mar 19, 2025
24 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category/umbraco-commerce review/developer Use this label if an internal developer review is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants