git / git/git.github.io

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

Ouverte
#830 4 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
CSS
Étoiles
373
Forks
325
Merge moyen
4 j 18 h
PR mergées (30 j)
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?

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Examinez la branche du repository et les commits proposés, en commençant par _config.yml et navbar.html, puis inspectez le site de prévisualisation pour vérifier la navigation groupée, les changements d’URL et les liens ajoutés. La tâche est terminée lorsqu’un maintainer a pris une décision concernant la structure proposée et a confirmé comment git-reference et htmldocs sont déployés sans être écrasés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
css, html, jekyll
Domaine
documentation, web-dev
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.