Git Product home page Git Product logo

lxd-ja's People

Contributors

hnakamur avatar tenforward avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

lxd-ja's Issues

2020-01-31 時点のドキュメントに更新

  • api-extensions.md
  • backup.md
  • cloud-init.md
  • clustering.md
  • configuration.md
  • daemon-behavior.md
  • database.md
  • debugging.md
  • dev-lxd.md
  • faq.md
  • image-handling.md
  • index.md
  • instances.md
  • migration.md
  • networks.md
  • production-setup.md
  • projects.md
  • rest-api.md
  • security.md
  • storage.md

titleの中のコメント

Google の検索結果のタイトルにコメントっぽい部分が含まれていて気づいたのですが、たとえば https://lxd-ja.readthedocs.io/ja/latest/containers/
<title>コンテナの設定 <!-- Container configuration --> - LXDドキュメント翻訳プロジェクト</title>
となっていて title 要素にコメントが含まれていて、昔はコメントとして扱われる仕様だったのにそうなっていないブラウザがあったのが、HTML5では実装に合わせてコメントとして扱われなくなったということらしいので、原文をコメントとして残すなら、別の行にするなどの対処をした方が良さそうです。

各ドキュメントのタイトル

各ドキュメントの最初のセクションタイトルが「イントロダクション」となっている文書が多く、Read the Docs で表示したときのメニューに「イントロダクション」が並んでしまう。

最初のセクションタイトルは文書名に合わせるとかしたい。オリジナルの英語ドキュメント側にもPR送りたい。

ドキュメントのテーマ

いつからか mkdocs で生成した文書のテーマが Bootstrap 風になっていた。このテーマ、デフォルトだと markdown ファイルごとに上部にメニューが作られてしまい、大量のメニューが表示され、コンテンツが隠されるように表示されていた。

一旦、"readthedocs" テーマを mkdocs.yml で設定したが、最小限の設定しか行っていないので見直す必要がある。Bootstrap 風テーマでもうまく調整できるのかもしれない。

ref) ff9b89d

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.