Skip to content

Include development info and re-shuffle home/about pages #640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ gem 'github-pages', group: :jekyll_plugins

# gem "webrick", "~> 1.7" # N.B. we may not want to fix this Gemfile to Ruby 3
gem "webrick"
gem 'jekyll-redirect-from'
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,25 @@

- 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).

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).


### Development

If you wish to spin up the site locally, you could follow the steps below.

* Make sure you've got ruby2 with dev-packages installed
* `sudo gem install bundler`
* Clone this repo
* `sudo apt-get install zlib1g-dev` # [
[ref](http://www.nokogiri.org/tutorials/installing_nokogiri.html#ubuntu___debian)
]
* `bundle install`
* `bundle exec jekyll serve`
* browse the site on http://localhost:4000

Based on https://help.github.com/articles/using-jekyll-with-pages/


<br>

Expand Down
2 changes: 2 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
name: Git Developer Pages
permalink: /rev_news/:year/:month/:day/:title/
plugins:
- jekyll-redirect-from
63 changes: 22 additions & 41 deletions _includes/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,22 @@
# About Git Developer Pages

This is a website to help Git Developers.

It is NOT a place to discuss Git issues. Please see
[git-scm.org's community page](https://git-scm.com/community)
for information about bug reporting or interacting with the
community.

The pages are maintained by editing files in the
[git/git.github.io](https://github.com/git/git.github.io) repository on
GitHub. It is then published on the
[https://git.github.io](https://git.github.io) GitHub page.

It is meant to be edited collaboratively like a wiki, except that
instead of a web form, you get to use a text editor and Git. What could
be better?

These pages also host the [Git Rev News](https://git.github.io/rev_news/),
see the [About Git Rev News](https://git.github.io/rev_news/rev_news/) page.

If you want push access, contact Christian Couder
< <[email protected]> > or Taylor Blau < <[email protected]> > and
provide your GitHub username. You may also send patches by mail (and
feel free to cc [email protected] if appropriate).


# Development

* Make sure you've got ruby2 with dev-packages installed
* `sudo gem install bundler`
* Clone this repo
* `sudo apt-get install zlib1g-dev` # ref [1]
* `bundle install`
* `bundle exec jekyll serve`
* browse the site on http://localhost:4000

Based on https://help.github.com/articles/using-jekyll-with-pages/

[1] http://www.nokogiri.org/tutorials/installing_nokogiri.html#ubuntu___debian

This is a website for information on Git development. If you stumbled into this
by mistake, you may want:
- Information on running Git and links to download the latest version from
[HERE](https://git-scm.com/)
- Wiki that has historically contained developer information from
[HERE](https://git.wiki.kernel.org/index.php/Main_Page)

These pages are intended to collect information useful to Git developers. This
is also the web home of:
- the [Hacking Git](https://git.github.io/Hacking-Git/) page,
- the [Git Rev News newsletter](https://git.github.io/rev_news/),
- the [involvement of the Git project in mentoring
programs](https://git.github.io/General-Application-Information/) like
[Outreachy](https://www.outreachy.org/) and the [GSoC (Google Summer of
Code)](https://summerofcode.withgoogle.com/)

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.
The [repository](https://github.com/git/git.github.io) could be found on GitHub.
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).
1 change: 0 additions & 1 deletion _includes/navbar.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<div id="navbar" class="navbar">
<ul>
<li><a href="/">Home</a>
<li><a href="/about">About</a>
{% for node in site.pages reversed %}
{% if node.navbar != false and node.title %}
<li><a href="{{node.url}}">{{node.title}}</a>
Expand Down
7 changes: 7 additions & 0 deletions about.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
permalink: /about
redirect_to:
- /
---

<!-- Used to exist but most information was just redundant to the homepage. So, redirect. -->
7 changes: 0 additions & 7 deletions about.md

This file was deleted.

22 changes: 1 addition & 21 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,4 @@ navbar: false

# {{ page.title }}

This is a website for information on Git development. If you
stumbled into this by mistake, you may want:

- <http://git-scm.com>, which has information on running
Git and links to download the latest version

- <http://git.wiki.kernel.org>, the wiki that has historically
contained developer information

These pages are intended to collect information useful to Git
developers. This is also the web home of:

- the [Hacking Git](https://git.github.io/Hacking-Git/) page,
- the [Git Rev News newsletter](https://git.github.io/rev_news/),
- the [involvement of the Git project in mentoring programs](https://git.github.io/General-Application-Information/)
like [Outreachy](https://www.outreachy.org/) and the
[GSoC (Google Summer of Code)](https://summerofcode.withgoogle.com/)

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).
{% include README.md %}