2
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

GitLab的ドキュメント文化の組織へのインストール

新型コロッケさわぎのころから、いろいろなものをGitHub保存するようにしてきました。組織内ドキュメントもGitHubでメンテナンスしながら作り上げていました。ただし、ドキュメントに含まれるコンテンツは「イベント予定」「働き方」「設備関連情報」「ソルバーの使い方」「業務フロー」「複合機やNASのIPとかのインフラ情報」などです。

しかし、この場合、Google検索を頼りにすることはできません。たとえばGitLabでは、ハンドブックと呼ばれるルールブックやドキュメントが完全公開されているため、Google検索が有効です。しかし、そんな勇気のある猛者はあまりいないと思います。秘匿したい情報もありますし、GitHub上のユーザーインターフェースは閲覧には適していません。特に検索能力は限られています。

検索能と非公開性の両立への一提案

この問題を解決するために、Sphinx、GitBook、Hugo、Honkitなどの静的サイトジェネレーター(SSG)を使用してドキュメントページを作成することを考えました。さらに、search-pro-kuiのようなプラグインを使用して検索機能を強化できます。また、スタティックサイトの生成(SSG)にHonkitって興味深いアプリ採用しました。Gitbookから派生したこのHonkitツールは、CLIアプリケーションとしての利便性を保ちつつ、オープンソースソフトウェアとしての自由度も高く、多くの開発者にとって魅力的な選択肢かもしれません。CLIはそのスピード感と直接的なコントロール感で、多くの場合、よりストレスフリーな体験を提供できます。これは良いアプローチですが、非公開性ということでホスティングには課題がありました。

この技術系ブログでも質問しましたが、VPNやソフトイーサを使用して非公開にする方法は、私には合いませんでした。たとえば、有名なホスティングサービスであるGitHub Pagesは無料で利用できますが、公開されてしまうため、私たちの目的には合いませんでした。私は無料で認証付きの非公開ホームページを作成したかったのです。

そこで、無料で利用できるVercelというホスティングサービスを見つけました。ミドルウェアとして機能するJavaScriptファイルをトップディレクトリに配置するだけで認証機能を追加できるのは、非常に便利です。Basic認証も無料で実装でき、私たちの要件にぴったりです。このような技術が、組織内のコミュニケーションや情報共有をスムーズにし、生産性を向上させることに繋がるでしょう。みんなに教えたくて、ここに投稿しました!

Refs.

2
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?