DSACMS / DSACMS/gov-codejson

Docs: Create a static site

未关闭
#2 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
summer2024
主要语言
没有语言数据
星标
5
派生
2
PR 合并指标
30 天内没有已合并 PR

描述

## MENTOR
- @natalialuzuriaga
- USDC SWE Fellow, OSPO
- Slack

## BRIEF DESCRIPTION

To provide more thorough and complete documentation on CMS code.json, we would like to create a static site with documentation similar to https://yml.publiccode.tools/index.html.

## SCOPING
- 1-2 weeks

## SKILLS NEEDED
HTML/CSS/JS, Static Web Development, GitHub Pages, Documentation writing

## REQUIRED DELIVERABLES
Make as clear of a step-by-step list as you can:
1. Research metadata standards and how they are documented.
2. Create structure and content for website. Identify sections/pages should be in the website. Some ideas are schema with explanation of each field, examples page, background/history pointing to legislation.
3. Find any potential templates to use for static site, look into use of USWDS
4. Develop website on this repository & ship

## DESIRED DELIVERY WINDOW
- June, July, or August

## NOTES/INSPO
Very excited for this one 🥳

# ACKNOWLEDGEMENTS
- [X] - Yes, I agree to spend file a project proposal ticket
- [X] - Yes, I agree this project falls within a 2 week or less (ideally less) scope of time
- [X] - Yes, I agree to spend an hour per week of office hours and 1x1 mentoring
- [X] - Yes, I agree to spend an hour at the end of the sprint for filling out a Retro Template

贡献指南

打开贡献指南

调研方向

首先检查仓库和所引用的 yml.publiccode.tools 文档网站,然后研究元数据标准并评估静态网站模板,包括 USWDS。定义网站的结构和内容,涵盖 schema、字段说明、示例以及背景信息或法律法规。文档网站在此仓库中开发完成并发布后,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
css, html, javascript
领域
documentation, web-dev
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。