2019年发布

优化搜索引擎的Sphinx文档

最近,我们在技术文档的SEO目的是帮助文档作者和项目维护人员创建文档这样最终用户可以更容易地找到他们想要的东西。

在我提到我们的新指南后,一位开发人员直截了当地问我,“谷歌不是堵住了网站用来提高排名的大部分漏洞吗?”。我以前听过一些技术专家的意见,所以我并不感到太惊讶。搜索引擎优化权威Moz.com,区分他们所说的黑帽SEO和白帽SEO区分这些“漏洞”和有助于SEO的更有用的网站改进。

阅读更多。。。


宣布API v3 Beta

在过去的几个月里,我们一直在努力改进我们的API。考虑到我们当前REST API v2的局限性,我们决定向前迈出更大的一步,创建一个新的API v3,将重点放在我们从现有用户那里听到的用例上。

与API v2相比,我们的新API v3有一些很大的不同,这使得它更加用户友好和有用。

阅读更多。。。


GSOC 2019:拉入请求的自动构建文档

为拉取请求构建文档是Read the Docs最需要的功能之一。类似于持续集成系统如何在每个pull请求上运行测试套件,此更改将为每个pull请求构建文档并将构建状态通知发送到提供者的状态API(例如Github状态API)。这将允许用户检查文档构建是否通过以及文档在合并到master之前的外观。

作为2019年谷歌代码夏令营(GSoC)的学生,我(马克苏杜尔·哈克)负责构建此功能。我的项目的主要目标是,无论何时创建拉取请求,都可以构建文档,并向提供程序的状态API发送生成状态通知。

阅读更多。。。


GSOC 2019:改进搜索结果和键入时的搜索

让用户能够轻松找到他们需要的信息对于阅读文档来说,一直以来都很重要。今年,我,瓦伊巴夫·古普塔,抓住提供的机会由Google Summer of Code改进搜索。我的主要目标GSoC项目分别为:

制作一个狮身人面像延伸为用户提供“搜索-键入”体验。

阅读更多。。。


将自定义CSS或JavaScript添加到Sphinx文档

在Read the Docs文档中,我们有一些操作指南帮助人们解决狮身人面像和阅读文档的具体问题。到目前为止,我们最受欢迎的指南正在播放向Sphinx添加自定义CSS和JavaScript.

在一些旧版本的狮身人面像中,这个过程更具挑战性从狮身人面像的文档中想出来怎么做也不容易。狮身人面像1.8确实简化了这个过程,特别是对于简单的情况。

阅读更多。。。


2019年场外阅读文件

2019年4月,Read The Docs团队刚刚完成了我们有史以来的第一次场外活动。我们第一次亲自聚会,并谈论了项目的未来。

图片会比我更好地显示这一点:

阅读更多。。。


阅读文档社区网站的新广告格式

我们将我们的广告计划视为保持“阅读文档”本身可持续发展的一种方式,并用它来更好地支持社区。广告使我们能够让全职员工添加新功能以及对我们的问题跟踪器中的问题作出响应。我们还能够与开源社区共享数千美元通过我们的收入分享计划和拨款。

目前,大约30%的网站流量没有任何广告。2016年我们首次推出道德广告时,我们只在特定文档主题.我们故意慢慢做,以确保我们的广告看起来完整通过阅读文档,减少了对用户的干扰。

阅读更多。。。


阅读文件的广告资金和道德广告的下一步

自我们首次推出以来已经三年了阅读文档上的广告虽然我们在我们的2018年统计数据,我们认为是时候对道德广告及其运作方式进行更新了。

我们的道德广告模式仍然很强大。我们证明了在广告之上建立商业模式是可能的无需求助于用户跟踪。与大多数其他广告支持网站不同,我们根据页面上下文显示广告,不是通过创建大量个人用户的行为简介。如果您正在浏览Python项目的文档,您可能会看到有关Pythons的相关广告。这很简单,很管用。

阅读更多。。。


新建配置文件

我们很高兴地宣布新版本的读取Docs配置文件(第2版)。

如果您是经常使用Read the Docs的用户,很可能您已经使用.读取文档.yml文件。

阅读更多。。。


开发人员面试技巧

上个月,Read the Docs团队进行了30-40次客户开发访谈招聘经理和招聘人员从5人公司到科技界大牌公司。我们想了解更多有关不同公司招聘流程的信息以建设为最终目标帮助公司寻找开发人员的产品.

上次,我们介绍了一些招聘经理小贴士根据公司告诉我们的情况。这次,我们一起求职者寻找下一份工作的技巧基于我们从招聘经理那里听到的见解。

阅读更多。。。


将新项目默认为Python 3

刚刚开始阅读文档的新项目现在将使用默认情况下为Python 3。虽然仍然可以将项目配置为使用Python 2.7与我们的配置文件,我们认为有助于推动Python生态系统采用Python3非常重要。

我们默认的Python版本目前是Python3.7。项目还可以选择使用默认构建映像的Python版本3.6和3.5。我们最终会但是,删除了对使用Python版本3.3和3.4构建项目的支持仍然可以选择支持任一版本的构建映像。

阅读更多。。。


改进的搜索

你是否曾为一个文档不完善的软件项目而苦苦挣扎过?如果一个有很好文档记录的项目,但在文档中找不到正确的部分,该怎么办?阅读文档核心团队已经意识到良好的文档搜索的重要性并让我以谷歌代码夏令营学生的身份接受挑战。我的GSoC项目的主要目标是重构搜索代码并升级后端搜索引擎,以及为我们的搜索功能添加更多功能,如精确匹配搜索,不区分大小写的搜索、键入时搜索、建议等。

GoogleSummerofCode是一个全球项目,学生们在其中与开源组织合作一个为期3个月的规划项目。Read The Docs的核心团队提出了一些项目思路,其中一个是重构并改进搜索代码.我(萨夫万·拉赫曼)很想弄脏我的手弹性搜索并抓住机会申请因为这个项目,我被录取了。

阅读更多。。。


招聘经理的经验教训

在过去的四周里,Read the Docs团队与工程招聘经理进行了数十次客户开发面试。我们想了解更多有关不同公司招聘流程的信息最终目标是构建一个产品来帮助公司找到开发人员。我们采访了在五人公司寻找人才的人,一直到科技界最知名的公司。在这篇文章中,我将介绍一些我们从招聘经理那里听到的常见信息分享一些招聘经理改进公司流程的方法.在我们的本系列的下一篇文章,我会有一些可行的建议基于相同面试的求职者。

由于这是一篇很长的帖子,我想分享一些关键的收获:

阅读更多。。。


传入Webhook弃用

在接下来的几周和几个月里,Read the Docs将转移一些项目从我们的传统传入webhook,到我们的项目级webhooks集成。

我们的传统传入webhook是我们第一次尝试允许像GitHub自动触发“阅读文档”项目的构建。这些webhooks缺乏许多安全功能,因此,大约两年前,我们取而代之的是基于项目的webhook集成。我们添加了一个数字那时,webhook集成项目的特性,我们停止了新的来自使用旧的传入webhook的项目。

阅读更多。。。


阅读Docs 2018统计数据

2018年是又一个好年景阅读文档.我们已经确定了一个对我们有效的可持续发展模式,并有一个由5人组成的团队全职参与该项目。

以下是我们过去一年的统计数据,我们已经出版了6年了。这是我们努力在组织中保持透明的一部分,以及我们的源代码。

阅读更多。。。