Skip to content

Commit c00f675

Browse files
committed
Include development info and re-shuffle home/about pages
The information to spin up the site locally got buried inside _includes/README in a recent change. It actually belongs to the README present in the root of the repo, too since that is what users see when viewing the repository. Hence, move that information there. The "About" page has long been very identical to the home page. So, shuffle the content in home and about pages and unify them into the Home page itself. For historical purposes, make the about page redirect to the homepage. Fixes git#610
1 parent 78bb7e3 commit c00f675

File tree

8 files changed

+52
-70
lines changed

8 files changed

+52
-70
lines changed

Gemfile

+1
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ gem 'github-pages', group: :jekyll_plugins
55

66
# gem "webrick", "~> 1.7" # N.B. we may not want to fix this Gemfile to Ruby 3
77
gem "webrick"
8+
gem 'jekyll-redirect-from'

README.md

+19
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,25 @@
1111

1212
- These pages are intended to be edited collaboratively (i.e., it is an alternative to us having a wiki, but one that is edited entirely via Git pushes).
1313

14+
You could also send your changes as patches by email to Christian Couder < <[email protected]> > / Kaartic Sivaraam < <[email protected]> > (and feel free to cc [email protected] if appropriate).
15+
16+
17+
### Development
18+
19+
If you wish to spin up the site locally, you could follow the steps below.
20+
21+
* Make sure you've got ruby2 with dev-packages installed
22+
* `sudo gem install bundler`
23+
* Clone this repo
24+
* `sudo apt-get install zlib1g-dev` # [
25+
[ref](http://www.nokogiri.org/tutorials/installing_nokogiri.html#ubuntu___debian)
26+
]
27+
* `bundle install`
28+
* `bundle exec jekyll serve`
29+
* browse the site on http://localhost:4000
30+
31+
Based on https://help.github.com/articles/using-jekyll-with-pages/
32+
1433

1534
<br>
1635

_config.yml

+2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
name: Git Developer Pages
22
permalink: /rev_news/:year/:month/:day/:title/
3+
plugins:
4+
- jekyll-redirect-from

_includes/README.md

+22-41
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,22 @@
1-
# About Git Developer Pages
2-
3-
This is a website to help Git Developers.
4-
5-
It is NOT a place to discuss Git issues. Please see
6-
[git-scm.org's community page](https://git-scm.com/community)
7-
for information about bug reporting or interacting with the
8-
community.
9-
10-
The pages are maintained by editing files in the
11-
[git/git.github.io](https://github.com/git/git.github.io) repository on
12-
GitHub. It is then published on the
13-
[https://git.github.io](https://git.github.io) GitHub page.
14-
15-
It is meant to be edited collaboratively like a wiki, except that
16-
instead of a web form, you get to use a text editor and Git. What could
17-
be better?
18-
19-
These pages also host the [Git Rev News](https://git.github.io/rev_news/),
20-
see the [About Git Rev News](https://git.github.io/rev_news/rev_news/) page.
21-
22-
If you want push access, contact Christian Couder
23-
< <[email protected]> > or Taylor Blau < <[email protected]> > and
24-
provide your GitHub username. You may also send patches by mail (and
25-
feel free to cc [email protected] if appropriate).
26-
27-
28-
# Development
29-
30-
* Make sure you've got ruby2 with dev-packages installed
31-
* `sudo gem install bundler`
32-
* Clone this repo
33-
* `sudo apt-get install zlib1g-dev` # ref [1]
34-
* `bundle install`
35-
* `bundle exec jekyll serve`
36-
* browse the site on http://localhost:4000
37-
38-
Based on https://help.github.com/articles/using-jekyll-with-pages/
39-
40-
[1] http://www.nokogiri.org/tutorials/installing_nokogiri.html#ubuntu___debian
41-
1+
This is a website for information on Git development. If you stumbled into this
2+
by mistake, you may want:
3+
- Information on running Git and links to download the latest version from
4+
[HERE](https://git-scm.com/)
5+
- Wiki that has historically contained developer information from
6+
[HERE](https://git.wiki.kernel.org/index.php/Main_Page)
7+
8+
These pages are intended to collect information useful to Git developers. This
9+
is also the web home of:
10+
- the [Hacking Git](https://git.github.io/Hacking-Git/) page,
11+
- the [Git Rev News newsletter](https://git.github.io/rev_news/),
12+
- the [involvement of the Git project in mentoring
13+
programs](https://git.github.io/General-Application-Information/) like
14+
[Outreachy](https://www.outreachy.org/) and the [GSoC (Google Summer of
15+
Code)](https://summerofcode.withgoogle.com/)
16+
17+
These pages are intended to be edited collaboratively (i.e., it is an
18+
alternative to us having a wiki, but one that is edited entirely via Git pushes.
19+
The [repository](https://github.com/git/git.github.io) could be found on GitHub.
20+
You could also send your changes as patches by email to Christian Couder <
21+
<[email protected]> > / Kaartic Sivaraam < <[email protected]> >
22+
(and feel free to cc [email protected] if appropriate).

_includes/navbar.html

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<div id="navbar" class="navbar">
22
<ul>
33
<li><a href="/">Home</a>
4-
<li><a href="/about">About</a>
54
{% for node in site.pages reversed %}
65
{% if node.navbar != false and node.title %}
76
<li><a href="{{node.url}}">{{node.title}}</a>

about.html

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
permalink: /about
3+
redirect_to:
4+
- /
5+
---
6+
7+
<!-- Used to exist but most information was just redundant to the homepage. So, redirect. -->

about.md

-7
This file was deleted.

index.md

+1-21
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,4 @@ navbar: false
66

77
# {{ page.title }}
88

9-
This is a website for information on Git development. If you
10-
stumbled into this by mistake, you may want:
11-
12-
- <http://git-scm.com>, which has information on running
13-
Git and links to download the latest version
14-
15-
- <http://git.wiki.kernel.org>, the wiki that has historically
16-
contained developer information
17-
18-
These pages are intended to collect information useful to Git
19-
developers. This is also the web home of:
20-
21-
- the [Hacking Git](https://git.github.io/Hacking-Git/) page,
22-
- the [Git Rev News newsletter](https://git.github.io/rev_news/),
23-
- the [involvement of the Git project in mentoring programs](https://git.github.io/General-Application-Information/)
24-
like [Outreachy](https://www.outreachy.org/) and the
25-
[GSoC (Google Summer of Code)](https://summerofcode.withgoogle.com/)
26-
27-
These pages are intended to be edited collaboratively (i.e., it is an
28-
alternative to us having a wiki, but one that is edited entirely via Git
29-
pushes).
9+
{% include README.md %}

0 commit comments

Comments
 (0)