From 3475be4db99636768c8045f750ce21cf2087d3dd Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Sun, 11 Aug 2013 00:18:50 +0200 Subject: [PATCH] Introduce README.md --- README.md | 37 ++++++++++++++++++++++++++ common.html | 66 ----------------------------------------------- index-common.html | 35 +++++++++++++++++++++++++ 3 files changed, 72 insertions(+), 66 deletions(-) create mode 100644 README.md delete mode 100644 common.html create mode 100644 index-common.html diff --git a/README.md b/README.md new file mode 100644 index 00000000000..3f6b71f05f0 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +--- +--- + +# Introduction + +This README lives at https://github.com/springframework/gh-pages#readme. +If you're seeing it within a specific Spring project's 'gh-pages' branch, that's +because this file, along with other files gets periodically merged in order to +share common content like headers and footers, CSS, etc. + +If you're reading this file + +## How to start a new 'gh-pages' Project page +From within your Spring project's git checkout directory: + + git remote add gh-pages-upstream https://github.com/springframework/gh-pages.git + git checkout --orphan gh-pages + git pull gh-pages-upstream gh-pages + + +## Create _config.yml file and add update your project info +For example: + + name: Spring Data JPA + baseurl: /spring-data-jpa + +## Create index.html +1. Copy common-index.html to index.html +2. Add your content + +## Commit your changes + git push origin gh-pages + + +# How to keep common gh-pages content up to date + git checkout gh-pages + git pull --no-ff gh-pages-upstream gh-pages diff --git a/common.html b/common.html deleted file mode 100644 index 3bd04ab6fc0..00000000000 --- a/common.html +++ /dev/null @@ -1,66 +0,0 @@ ---- -layout: default -title: {{ site.project_name }} ---- - -
-
-
-
- Projects -
-
-
-
- - - - -
- -
-
{{ site.project_name }}
- -
-

To start a new 'gh-pages' Project page

- From within your Spring project's git checkout directory: - 
-git remote add gh-pages-common https://github.com/springframework/common.git
-git checkout --orphan gh-pages
-git pull gh-pages-common gh-pages
-
- -

Edit _config.yml file and add update your project info

- For example: - 
-name: Spring Data JPA
-baseurl: /spring-data-jpa
-
- -

Create index.html

-
    -
  1. Copy this file (common.html) to index.html
    2. -
  2. Delete these instructions
    3. -
  3. Add your own content
    4. -
- -

Commit your changes

- 
-git push origin gh-pages
-
- -

To update common content

- 
-git checkout gh-pages
-git pull --no-ff gh-pages-common gh-pages
-
-
-
Quick Start
-
-
- -
-
-
-
-
diff --git a/index-common.html b/index-common.html new file mode 100644 index 00000000000..0d53f5466b3 --- /dev/null +++ b/index-common.html @@ -0,0 +1,35 @@ +--- +layout: default +title: {{ site.project_name }} +--- + +
+
+
+
+ Projects +
+
+
+
+ + + + +
+ +
+
{{ site.project_name }}
+ +
+ YOUR CONTENT HERE +
+
Quick Start
+
+
+ +
+
+
+
+