loopbackio / loopbackio/loopback-next

docs: move recipes to how-to guides

Đang mở
#5,783 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Docs epic Hacktoberfest
Ngôn ngữ chính
TypeScript
Star
5.1k
Fork
1.1k
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
27

Mô tả

At the moment, many pages in "Behind the scenes" are mixing explanations with how-to guides. This makes it difficult for our users to find the relevant content (a recipe to achieve the outcome they want).

As part of our adoption of the four-quadrant documentation system (see #5549 and #5718), we should extract all guides from explanation pages into guide pages (see #5768 for inspiration) and keep explanation pages focused on explaining the concepts & providing background information.

This story is a part of #5113 Documentation improvements 2020Q3.

🎆 Hacktoberfest 2020

Greetings 👋 to everybody coming to this issue with the desire to help us improve our docs and score a pull request (or more?) in this year's Hacktoberfest challenge.

Here are few tips 👀 to make your start easier:

  • Pick a task (a doc page) from the check-list below and leave a comment to let others know that you are going to work on it. Some of the tasks have a dedicated GitHub issue created, please check that issue for more details.
  • Some doc pages have a lot of content, the amount of effort needed may feel intimidating. Don't worry! It's perfectly fine to pick just one section and convert it into a How-to guide. Baby steps FTW, every little helps!
  • If you are new to GitHub pull requests, then you can learn about the process in Submitting a pull request to LoopBack 4.
  • If this is your first contribution to LoopBack documentation, then read Documentation guide for LoopBack 4 developers please. Consider previewing loopback-next docs only for a faster feedback loop. Finally, please refer to Contributing to LoopBack documentation for a more advanced information on our Jekyll-based documentation infrastructure.
  • Feel free to ask for help in #loopback-contributors channel, you can join our Slack workspace here.

📋 List of pages to rework

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Chọn một trang chưa được đánh dấu trong checklist, chẳng hạn như Application.html, Controllers.html hoặc một trang về quan hệ, rồi đọc trang đó cùng với hướng dẫn tài liệu bốn góc phần tư và issue #5768. Trích xuất nội dung how-to của trang thành một trang hướng dẫn, đồng thời giữ cho trang gốc tập trung vào các khái niệm và bối cảnh. Công việc được xem là hoàn tất khi trang đã chọn được làm lại và mục tương ứng trong checklist hoặc issue riêng đã được cập nhật.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
jekyll
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.