git / git/git.github.io

Test website: Grouping in navigation bar, relative/absoulte URLs and links to Git Reference and HTML docs

オープン
#830 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
CSS
スター
373
フォーク
325
平均マージ
4日 18時間
マージ済み PR(30日)
1

説明

Hello.
This is a presentation (and request for comments) of test version of https://git.github.io with 3 separate features:

  • link grouping in left navigation bar
  • using relative/absolute URLs to git.github.io
  • links to "Git Reference" and "Git HTML docs"

Preview site: https://muxajibi4.github.io/git.github.io/

Repo: https://github.com/MuxaJIbI4/git.github.io on branch 'master'

1. Link grouping in navigation bar

see MuxaJIbI4/git.github.io@da0819c

This is done by moving all pages (except /rev_news) to new /links folder and subfolder inside determines page's group (defined using scope in _config.yml). Then in navbar.html we show groups titles followed by that group pages. Ordering of groups determined by array nb-order in _config.yml. This approach allows not assign group to each page inside 'front matter'.
Also pages inside one group can be ordered using 'order:' property inside pages of the group.
Also although some pages are moved into /links/* folders their links are not changed because of permalink: option in _config.yml.

Group titles and ordering, assigning group to pages, changed page titles, names of /links folder and subfolders are given only as an example

2. Using relative/absolute URLs to git.github.io

see MuxaJIbI4/git.github.io@135a957

This removes hard-coded domain name from subpages.
Removed only in some files - didn't touch /_posts and /links.
Also did not change direct links to /images folder in /_posts and /links.

3. Links to "Git Reference" and "Git HTML docs"

see MuxaJIbI4/git.github.io@b010429

There are 2 additional websites on git.github.io that don't have any links to them (you can find out about them only from outside sources):
https://git.github.io/git-reference - Git Reference
https://git.github.io/htmldocs - Git HTML docs

So I decided to add them to Navigation bar and to the Main page.
On test website link don't work since they are external websites, but URL itself should be correct.

Question: Can somebody tell how do these 2 websites are being deployed and not being overwritten by deployment of git.github.io?

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

_config.yml と navbar.html から始めて、提案されたリポジトリのブランチとコミットを確認し、その後、プレビューサイトでグループ化されたナビゲーション、URL の変更、追加されたリンクを調査します。提案された構成について maintainer が判断し、git-reference と htmldocs が上書きされずにどのようにデプロイされるかを確認できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
css, html, jekyll
領域
documentation, web-dev
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。