Comments (6)
@mtrezza @dblythy tell me what you think π
from docs.
I think a E2E tutorial is always a great way for new developers to learn code by coding. This works so well because a tutorial leaves out many detailed stuff so you get to results quickly, which is an important motivational factor. A good structure for a tutorial may be a series that builds upon the previous chapter, gradually extending the capabilities of the example app. Another benefit of this would be that even if steam runs out along the way and contribution slows down, the produced material would still be of value and can stand as tutorials.
We cannot use ChatGPT to create docs because it's a copyright minefield in uncharted legal territory. We don't know the source of the generated content and how it can be used. Basing official documents on that would be an unquantifiable risk.
Aside from that, I don't think that ChatGPT would be a useful tool for generating a tutorial. I've been using it for a while now and its answers are rather generic, while a tutorial is focused on custom code and explanations for a specific example app.
from docs.
thanks @mtrezza for your feedback.
A good structure for a tutorial may be a series that builds upon the previous chapter, gradually extending the capabilities of the example app.
Exactly what i'm thinking about.
I'm in favor of a tutorail covering at the same time JS SDK, REST API and GraphQL API.
We can use https://github.com/Ovski4/jekyll-tabs to provide detailed variations for each API.
@mtrezza to be able to prepare the E2E tutorial structure, can you open on this repo a Project. It will be easier to collaborate.
I think a "Trello" like app could be a good candidate.
The app description:
Trello like app, support login via email/password, A user can create a Team. Each team can have 20 boards max. An admin Team user can invite other users to the team or to a specific board. A board has default and custom columns. Each colum has tasks with name, description, comments, and files. The app support realtime task moves. The app is packaged in a Docker container, deployed on a container cloud platforme (Azure container/GCP Cloud run/AWS fargate).
The app should have tests with Jest to cover the business logic, and ensure that the tutorial work. The app only cover api calls.
The final repo with all tests (for each API (GQL, SDK, REST)) should be hosted on parse-community/trello-like-app
Basic chapters i see:
- Setup the project install and run parse-server with NodeJS
- Create the DB schema with defined schema or API (indexes also)
- Signup a user and get the current user (we will cover only email/password first)
- The user create his first Team (security included with ACL,CLP)
- The user create his first board, (cloud functions that automatically create column), first task (security included with ACL,CLP)
- The user add a comment on his first task, move the task in another column, add a file to the task
- The user invite another user to join the Team, and invite another user to only join a board
- Add realtime task moves to the app
- Remove a user from the Team and the board
- Install Jest and cover features of the app.
- Package the app in a container and ship it to a container service
Later:
- Google, third party logins, MFA
- Implement a little search engine (tokenized string array based on task name)
- Frontend installs (Parse JS SDK, GraphQL (appollo hooks), Rest (react query)) ?
from docs.
Sure, I've created https://github.com/orgs/parse-community/projects/10/ with you as the only member with write access; feel free to invite others as needed.
from docs.
Can we close this, since the tutorial has its own repository and project to track its development?
from docs.
Yes @mtrezza, we will see later how to implement e2e docs into the main doc repo
from docs.
Related Issues (20)
- π Change block codes format to jsonc
- π Fix json example HOT 1
- π Navigation links in the API page are broken HOT 5
- π Wrong link to the API Reference in JavaScript block HOT 1
- π Improving Parse Server AWS guide
- π Refurbishment of Python code examples HOT 3
- Endpoint `loginAs` is falsely documented to require GET request HOT 6
- Remove forms that request sensitive information
- Parse Server Option `enforcePrivateUsers` not documented HOT 3
- π Remove reference to `{ usePost: true }` option in login documentation
- π How to use Defined Schema on existing Parse Server installation
- Update to PS6 π
- Create Rate Limit docsπ
- Create auth adapter docs
- Fix docs page HOT 6
- Documentation HOT 2
- π
- πProvide information on using Facebook's Limited Token
- π Missing examples throughout the docs HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docs.