Skip to content
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

XM Cloud Tutorial - Initial feedback round #784

Closed
jst-cyr opened this issue May 14, 2024 · 3 comments · Fixed by #789
Closed

XM Cloud Tutorial - Initial feedback round #784

jst-cyr opened this issue May 14, 2024 · 3 comments · Fixed by #789
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jst-cyr
Copy link
Contributor

jst-cyr commented May 14, 2024

Gathering up initial feedback from community members to revise first draft of XM Cloud tutorials.

  1. Setup XM Cloud Tutorial:
    • It would be beneficial to explain what a project and an environment are before discussing the setup process. This could help users logically understand the concepts.
  2. Create a site
    • There is a note regarding "site identifier." While reading that note, I couldn't understand why it was added until I saw the screenshot of the create site dialog. Perhaps we could add a reference in the note to clarify this.
  3. Create a Component
    • Could we add an introduction explaining what "no-code components" or "FeaaS components" are so that readers can get an idea about them at the beginning of the tutorial?
    • There seems to be a spelling mistake in this note: "note" instead of "not": "This validates that the component is available to authors. If it does not display in this list, then the component may note have been staged or published yet."
    • Should have info/link about different ways of Component creation like code/nocode/BYOC,Pros/Cons of each, then we can proceed with example
  4. Create Component Data Sources
    • From one user: The steps are provided in detail. However, I felt that it is lengthy. Others may have a different opinion about this, but I was thinking if we could split it into two documents or so. (Now on XM Cloud Tutorial - Split up Datasources tutorial #790)
    • From another user: I agree it's long and you can try breaking down it in to smaller modules and units to keep it interesting. One module can have many units and on each unit completion give some points , especially for newbies who might feel overwhelmed with steps and never start it. (Now on XM Cloud Tutorial - Split up Datasources tutorial #790)
  5. All tutorials are using the same OpenGraph image
@jst-cyr jst-cyr added the documentation Improvements or additions to documentation label May 14, 2024
@jst-cyr jst-cyr self-assigned this May 14, 2024
@jst-cyr
Copy link
Contributor Author

jst-cyr commented May 14, 2024

Moved feedback about splitting up the Data sources into separate issue #790 as it may need to take more time.

@jst-cyr
Copy link
Contributor Author

jst-cyr commented May 15, 2024

Added new fix request regarding component creation options. Should link off to details about different options.

@jst-cyr
Copy link
Contributor Author

jst-cyr commented May 15, 2024

Moved troubleshooting request to #799

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant