Guides RFC - #1 Thinking in JSS

Sitecore / jss

Software development kit for JavaScript developers building web applications with Sitecore Experience Platform

https://jss.sitecore.com

Apache License 2.0

262 stars 272 forks source link

Guides RFC - #1 Thinking in JSS #432

Closed anastasiya29 closed 2 years ago

anastasiya29 commented 4 years ago

RFC background

We have published the 1st version of JSS Guides & Recommended Practices. This content will ultimately be merged into the JSS Documentation site, and we'd love for the community to be a part of this milestone. We welcome your feedback, questions, change suggestions, and additional content.

Category - Thinking in JSS

We’ve create GitHub issues for the 7 topic categories to facilitate group discussion - this issue is for discussing the Thinking in JSS category.

Topics in this category:

How to contribute

Post your comments here, or
Use this link to leave inline comments in the markdown files, or
Use the Edit this on GitHub link at the bottom of each guide page to submit edits for specific pages, or
Submit pull requests to the guides branch

Go to next category :arrow_right:

nickwesselman commented 4 years ago

From AF on Twitter:

This section includes content for ✨front-end developers✨ who are working with #SitecoreJSS without previous #Sitecore experience, based directly on dev feedback from real projects.

Perhaps we should indicate the intended audience for each guide section?

jst-cyr commented 4 years ago

On the "Thinking in JSS -> JSS vs JS" page the "Edit this page on GitHub" link goes to the wrong page.

Instead of going to the js-vs-jss it goes to the terminology page.

jst-cyr commented 4 years ago

Regarding the JSS vs JS page, from Matt Fletcher on LinkedIn:

Saw a “todo” in the hybrid section, not sure if its intentional for further additions or not

I removed the TODO for now, but in case that was supposed to be there wanted to put the comment here and the source. The Linked comment also has the screenshot.

ThomPuiman commented 4 years ago

Some comments with regards to Thinking in JSS:

Developer Workflow has a typo: 'Reducing risk in log-term Code-First development' and 'Sitecore devs are free to reogranize templates'
Sitecore Terminology typo: 'Presentations Details' with s
Should the concept of Dictionary be included in Sitecore Terminology?
I'm not entirely sure whether this should be the responsibility of a frontend dev, but considering they'll be the ones initially defining the components and templates, should there be some best practices about insert options/placeholder settings (allowed controls). Or would this be a task that generally the Sitecore/backend dev does ones the project is Sitecore First?
I think it should also be mentioned that naming of components and templates should be done with the Content Author/Business User in mind, considering the JSS devs will determine the component names.

sc-CalvinWilliams commented 4 years ago

I found what seems like malformed bullet points https://www.screencast.com/t/GeljsjM8 in the "js vs jss" section

Found a small typo https://jss-docs-preview3.herokuapp.com/guides/thinking-in-jss/developer-workflows/#reducing-risk-in-log-term-code-first-development:~:text=needs.-,Reducing%20risk%20in%20log%2Dterm%20Code%2DFirst%20development log-term -> long-term

Also a weird character(emoji?) does not render https://www.screencast.com/t/hVCLWHbrNv8 both in the "Developer Workflows" section

stale[bot] commented 2 years ago

This has been automatically marked as stale because it has not had recent activity. It will be closed if there is no further activity within 30 days. You may add comments or the 'keep' label to prevent it from closing. Thank you for your contributions.