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.

Sign up for GitHub

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

Jump to bottom

docs: draft proposal for docs improvement #3164

Closed
wants to merge 7 commits into from
Closed

docs: draft proposal for docs improvement #3164

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d031403
docs: proposal
dhmlau Jun 14, 2019
898898d
docs: fix formatting
dhmlau Jun 14, 2019
01492f0
docs: added more desc
dhmlau Jun 20, 2019
e885101
docs: apply feedback
dhmlau Jun 24, 2019
66d5060
docs: more updates
dhmlau Jun 25, 2019
6dfa6fd
docs: new sidebar proposal
dhmlau Jul 8, 2019
9cc2355
docs: apply feedback on sidebar changes
dhmlau Jul 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions docs/site/site-proposal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,69 @@ docs improvement, I'd like to propose the following changes.

- Considerations for GDPR readiness

## Proposed Changes on sidebar

Mapping the existing contents to the new sidebar structure:

- Overview (new sidebar item. it will point to index.md)
- Getting started
- Tutorials
- Basic building block
- Application
- Server
- Controllers
- Model and Model Relations
- Repositories
- Service Proxy (no matching content??)
- DataSources and Connectors
- Observers(same as `Life cycle events and observers`) and Interceptors
- Application life cycles
- Booting an Application
- Usage scenario (better than `Developer Experience`?)
- Create APIs
- Top down vs bottom up (new page)
- OpenAPI (new page)
- Exposing GraphQL APIs
- Access databases (new page)
- Database migrations
- Calling other APIs
- Integrate with other infrastructure (new intro page)
- Authentication
- Authorization
- Debugging (new page)
- Deployment
- Deploying to IBM Cloud
- Deploying to Kubernetes on IBM Cloud
- Deploying with pm2 and nginx
- Behind the scene
- Context
- Binding
- Dependency injection
- Components
- Request/Response processing flow

- Routes
- Sequence

- Extending LoopBack
- Decorators
- Error handling
- Examples
- CLI References
- API docs
- For LoopBack 3.x users
- Differences between v3 and v4
- Migration guide
- Best Practices
- References

Question: I have trouble mapping the following contents. Please help:

- Serving static files ??
Copy link
Contributor

Choose a reason for hiding this comment

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

This should go under Usage scenario.

- Self-hosted REST API Explorer -> Under "Extending LoopBack"?- Boot and Mount a
Copy link
Contributor

Choose a reason for hiding this comment

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

This should go under Create APIs.

LoopBack 3 Application -> Under "For LoopBack 3.x users"?
- Remove "Crafting LoopBack 4"??
Copy link
Contributor

Choose a reason for hiding this comment

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

We can have an Architecture section, including Behind the scene

Copy link
Member Author

Choose a reason for hiding this comment

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

I've renamed the behind the scene to architecture now.


## Proposed Changes on Individual Section

### Tutorials
Expand Down