Readthedocs.org: Cara menonaktifkan peringatan "Anda tidak menggunakan versi terbaru"

Dibuat pada 31 Agu 2015 · 4Komentar · Sumber: readthedocs/readthedocs.org

Terima kasih telah membuat ReadTheDocs menjadi yang pertama. Saya baru mengetahui bahwa penawaran .com diluncurkan sehingga Anda dapat mengharapkan kami dari Graylog untuk segera meningkatkan.

Kami merilis v1.2 dari perangkat lunak kami sebagai RC hari ini. Saat mengaktifkan cabang 1.2 di RTD, saya melihat peringatan ini di halaman RTD 1.0 dan 1.1 :

Anda tidak menggunakan versi perpustakaan terbaru. 1.2 adalah versi terbaru.

Versi default saat ini adalah 1.1 jadi semua orang yang membuka dokumentasi akan melihat peringatan itu. Ini menyesatkan karena 1.2 belum stabil.

Bisakah kita menonaktifkan peringatan itu entah bagaimana?
Bisakah kita mengubah salinan/teks peringatan? Peringatan itu masuk akal setelah 1.2 dirilis GA tetapi kami tidak mendokumentasikan _library_.

Sekali lagi terima kasih dan beri tahu saya jika Anda memerlukan informasi lebih lanjut.

Improvement design decision

Sumber

lennartkoopmann

👍2

Komentar yang paling membantu

Benjolan lembut pada ini dengan beberapa pemikiran tambahan:

Cara untuk menyesuaikan penggunaan kata 'perpustakaan', karena banyak proyek yang menggunakan readthedocs bukan perpustakaan
i18n yang tepat (mungkin sebagai cara untuk menyelesaikan poin terakhir)
Cara untuk sepenuhnya menonaktifkan peringatan
Mungkin "daftar putih" versi yang tidak diberi tag. Misalnya, Apache CouchDB mendukung (n, n-1) versi. Jadi, rilis terbaru di lini 1.x dan 2.x kami didukung. Kami tidak ingin menampilkan peringatan di halaman 1.7.0 kami (jika ini adalah rilis 1.x terbaru), tetapi kami ingin menampilkannya di 1.6.1 dan 2.1.0 (jika 2.1.1 adalah yang terbaru 2.1 .1 rilis).

wohali pada 6 Nov 2017

👍3

Semua 4 komentar

@lennartkoopmann hebat! kami perlahan meluncurkan informasi lebih lanjut tentang readthedocs.com, jadi tetap disini

Melihat ini sedikit, saya pikir ada cara yang jelas untuk menonaktifkan fitur itu, tetapi sepertinya tidak ada. Mungkin ini harus hidup sebagai opsi tema RTD, dan javascript ditingkatkan untuk mendeteksi apakah tema dapat menerima peringatan.

Blok akan ditambahkan di sini, tetapi tidak banyak membantu untuk mendeteksi apakah itu harus menambahkan blok, dan melompati i18n sama sekali:
https://github.com/rtfd/readthedocs.org/blob/f7a05381cfe96fb8480e2f5dccba45fc7127957d/readthedocs/core/static-src/core/js/doc-embed/version-compare.js#L9 -L32

agjohnson pada 31 Agu 2015

Kami memiliki masalah yang sama:

kata-kata yang buruk (sw kami bukan perpustakaan)
catatan itu tampaknya merekomendasikan bahwa 1.1.0b1 beta kami lebih baik daripada rilis stabil 1.0.7 kami.

http://borgbackup.readthedocs.io/en/1.0.7/

ThomasWaldmann pada 4 Sep 2016

Benjolan lembut pada ini dengan beberapa pemikiran tambahan:

Cara untuk menyesuaikan penggunaan kata 'perpustakaan', karena banyak proyek yang menggunakan readthedocs bukan perpustakaan
i18n yang tepat (mungkin sebagai cara untuk menyelesaikan poin terakhir)
Cara untuk sepenuhnya menonaktifkan peringatan
Mungkin "daftar putih" versi yang tidak diberi tag. Misalnya, Apache CouchDB mendukung (n, n-1) versi. Jadi, rilis terbaru di lini 1.x dan 2.x kami didukung. Kami tidak ingin menampilkan peringatan di halaman 1.7.0 kami (jika ini adalah rilis 1.x terbaru), tetapi kami ingin menampilkannya di 1.6.1 dan 2.1.0 (jika 2.1.1 adalah yang terbaru 2.1 .1 rilis).

wohali pada 6 Nov 2017

👍3

Kami merilis v1.2 dari perangkat lunak kami sebagai RC hari ini. Saat mengaktifkan cabang 1.2 di RTD, saya melihat peringatan ini di halaman RTD 1.0 dan 1.1

Setelah https://github.com/rtfd/readthedocs.org/pull/3331 digabung, jika 1.0 dan 1.1 adalah tag, ini seharusnya tidak menjadi masalah lagi :)