Create documentation on Supported Content types on developer.yoast.com
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- markdown
调研方向
首先查看 developer/docs/features/analysis 和 issue 226 中的文档要求,因为此任务受限于指向这些页面的链接。使用所示的 Docusaurus front matter 创建 content-types 文件夹,其中包含 overview.md 和针对各内容类型的页面。完成标准是概览页面链接到每种受支持的类型,并且各页面通过清晰的表格记录可用的评估。
由索引模型根据 Issue 内容生成。
描述
Please give us a description of the issue
- I've read and understood the contribution guidelines.
- I've searched for any related issues and avoided creating a duplicate issue.
This task was created as part of this task: https://github.com/Yoast/non-dev-tasks/issues/39
See report in first comment to this task for context.
Blocked by https://github.com/Yoast/developer/issues/226 because links need to created to pages that are created in that task.
Supported Content types
In developer/docs/features/analysis create a folder called content-types.
overview.md
Within this folder we create one overview.md with some general information about supported content types and links to all specific docs in docusaurus.
The overview should have a docusaurus header like such:
---
id: contentTypeOverview
title: "Content Types: Overview"
sidebar_label: overview
description: This documentation provides an overview of the different content types we support.
---
List of content types:
- Post/Page/CPT
- taxonomy
- product/Shopify Product
- ...
content type specific pages.
---
id: postPageCPT
title: "Content Types: Post/Page/CPT"
sidebar_label: Post/Page/CPT
description: This documentation provides information on what assessments are available for Posts/Pages/CPTs and how they are available.
---
This could contain a table of all Assessments (with hyperlink to their docusaurus page that was created in https://github.com/Yoast/developer/issues/226) and some additional information
| Assessment | Content type Specific config |
|---|---|
| Keyphrase in introduction | ❌ |
| Keyphrase length | ❌ |
| ... | ... |
Think about whether other columns might be applicable to the table.
- 主要语言
- JavaScript
- 星标
- 15
- 派生
- 23
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
Yoast/developer 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 78/100
-
难度 5/5 一周以上 新手友好度 25/100
-
Typos 未关闭
难度 2/5 1-3 小时 新手友好度 48/100
-
bug
难度 3/5 1-2 天 新手友好度 55/100
-
难度 4/5 3-5 天 新手友好度 35/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
antfu-collective/icones#398 ·
-
ECmail.com 未关闭
难度 1/5 1 小时以内 新手友好度 90/100
wesbos/burner-email-providers#554 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
radiantearth/stac-browser#1023 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 75/100
components-web-app/docs#92 ·