DSACMS / DSACMS/gov-codejson

Docs: Create a static site

Đang mở
#2 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
summer2024
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
5
Fork
2
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

## 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

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

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

Hướng nghiên cứu

Bắt đầu bằng việc xem xét repository và trang tài liệu yml.publiccode.tools được tham chiếu, sau đó nghiên cứu các tiêu chuẩn metadata và đánh giá các template cho site tĩnh, bao gồm USWDS. Xác định cấu trúc và nội dung của site, bao quát schema, phần giải thích các trường, các ví dụ và bối cảnh hoặc pháp luật. Công việc được xem là hoàn tất khi site tài liệu được phát triển trong repository này và được phát hành.

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

Đánh giá

Công nghệ
css, html, javascript
Lĩnh vực
documentation, web-dev
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.