oceanhackweek / oceanhackweek/oceanhackweek.github.io
Use ReadTheDocs
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- CSS
- Star
- 12
- Fork
- 49
- Merge trung bình
- 19 phút
- Pull request đã merge (30 ngày)
- 1
Mô tả
Currently we're using Github Pages for hosting and Netlify for PR previews. We keep having issues due to Netlify's Python environment, and it's lack of support for Conda making our packages fall out of sync.
ReadTheDocs now supports Conda/Mamba, so we could simplify our environment, and have the same service manage the build and PR previews.
I remember we had some discussion about RTD before, and I can't remember exactly why we didn't use them and instead built our own versioning scheme. Was it due to the advertising? We can opt it out of advertising by someone getting a membership, which I just tried for Xpublish.
To get our existing old sites, we would probably want to tag the desired commits, then use post_build customization to pull those in. The other place to customize might be to use single version mode.
xref: #237 @emiliom @ocefpaf
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng việc xem xét cấu hình GitHub Pages và Netlify hiện tại, sau đó đọc cuộc thảo luận trước đây trong #237 và tài liệu ReadTheDocs được liên kết về Conda, post_build và single-version mode. Công việc được xem là hoàn tất khi có một kế hoạch di chuyển đã được thống nhất, bao quát các bản build, bản xem trước PR và các site cũ hiện có; không có file triển khai hay test nào được nêu tên.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- anaconda, github
- Lĩnh vực
- devops, documentation
- Loại issue
- Tính năng
- Độ 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
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100