oceanhackweek / oceanhackweek/oceanhackweek.github.io

Use ReadTheDocs

未关闭
#249 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
CSS
星标
12
派生
49
平均合并
19 分钟
30 天内合并 PR
1

描述

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

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先检查当前的 GitHub Pages 和 Netlify 配置,然后阅读 #237 中之前的讨论,以及链接的关于 Conda、post_build 和 single-version mode 的 ReadTheDocs 文档。完成标准是需要有一份经各方同意的迁移计划,涵盖构建、PR 预览和现有的旧站点;未指定实现文件或测试。

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

评估

技术栈
anaconda, github
领域
devops, documentation
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

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