git / git/git.github.io

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

Open
#830 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
373
Forks
325
Avg merge
4d 18h
Merged PRs (30d)
1

Description

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?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the proposed repository branch and commits, starting with _config.yml and navbar.html, then inspect the preview site for the grouped navigation, URL changes, and added links. Done requires a maintainer decision on the proposed structure and confirmation of how git-reference and htmldocs are deployed without being overwritten.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, html, jekyll
Domain
documentation, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.