Help, blog, API documentation, and much more for the ADS services
HTML CSS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.sass-cache/5f2912af614c814cad81c553ad121fa74a066a30 fixed sidebar Jul 20, 2015
_includes
_layouts Added about page - initial merge (#103) Mar 30, 2018
_sass Added welcome video to help page front screen Jun 21, 2018
about Added application links for job postings Jul 18, 2018
blog Fixed tags in post Jul 17, 2018
bower_components initial commit Feb 6, 2015
css
help modified: help/faq/_posts/2017-10-24-faqs.md (#126) Jul 18, 2018
img Literature search quick start guide, removed beta from About page header Apr 30, 2018
jobs More formatting Dec 30, 2016
.gitignore
AUTHORS.md Update AUTHORS.md Oct 21, 2015
CONTRIBUTING.md Updating some documentation Oct 21, 2015
LICENSE.md Updating some documentation Oct 21, 2015
README.md Updated README to include Jekyll install instructions Feb 8, 2018
_config.yml Blogpost: Author smackdown Feb 10, 2016
android-chrome-192x192.png Added favicons Oct 13, 2017
android-chrome-512x512.png Added favicons Oct 13, 2017
apple-touch-icon.png Added favicons Oct 13, 2017
bbb_favicon-16x16.png Added about page - initial merge (#103) Mar 30, 2018
bbb_favicon.ico Added about page - initial merge (#103) Mar 30, 2018
browserconfig.xml Added favicons Oct 13, 2017
favicon-16x16.png
favicon-32x32.png
favicon.ico 100M citations blog post Oct 13, 2017
feed.xml Update feed.xml May 11, 2017
index.md
manifest.json Added favicons Oct 13, 2017
mstile-150x150.png Added favicons Oct 13, 2017
safari-pinned-tab.svg Added favicons Oct 13, 2017

README.md

ADS Help and Blog pages

Static web pages that serve the help and blog pages of the NASA/SAO Astrophysics Data System.

Current pages

Updating the help pages

All the help pages can be found under the folder help. To add new content, you will have to read about how jekyll's layout system works. A quick way to add content is to:

  1. Add a new folder, eg., help/my_help/
  2. Add a landing page, eg., help/my_help/index.md
  3. Add a _posts folder, eg., help/my_help/_posts
  4. Add a post, eg., help/my_help/_posts/2015-10-10_my_first_post.md

You can now access your help pages at http://localhost:4000/help/my_help/ which loads the index.md, and any relevant content that it references within 2015-10-10_my_first_post.md can be added to the index.

If making a pull request, follow the rules described in CONTRIBUTING.md.

Adding a category

Unfortunately if you add a new category (e.g. "search", "actions", "userpreferences"), you need to do some configuration beyond adding the folder with the category name, with an index.html and _posts folder. You also need to add some markup to _includes/left-nav.html (use the previous accordion divs as a template).

Contributing a blog post

All the blogs are kept under the folder blog/_posts/. The following rules must be kept to when making a blog post:

  1. Name the file with DATE_NAME.md, eg., 2015-10-10_my_post.md
  2. Within the file, you must include the following content at the top of the file:
```
---
layout: blog_post
title: "Title of your blog"
author: "Author of your blog"
position: "Job position of author"
category: blog
label: general
thumbnail: blog/images/blog_DATE_thumbnail.png
---
```
* `layout`: leave as blog_post
* `title`: modify to your needs
* `author`: modify to your needs
* `position`: modify to your needs
* `category`: leave as blog
* `label`: this can be a string, or list. Allowed values: 'general', 'technical', 'news'. The choice of label will decide where it is viewed within the blog.
* `thumbail`: path to the thumbnail, assumes its within the git repository

For more information on formatting within jekyll you can read here, or any other places that has information about markdown. Markdown can also render HTML if you prefer to write using that.

If you wish to see the content you are writing while working in markdown, the recommended tool as of October 2017 is grip. Other ones we have considered/used in the past are dillinger.io or some programs such as haroopad.

If making a pull request, follow the rules described in CONTRIBUTING.md.

For development

The help pages are static web pages built using Jekyll (written in Ruby) and taking avantage of GitHub's support of Jekyll. To run locally, first install Ruby, then Jekyll:

  • install GnuPG:
    brew install gnupg

  • get the public key:
    gpg --keyserver hkp://pgp.mit.edu --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB

  • install the Ruby version manager and the latest stable version of Ruby:
    \curl -sSL https://get.rvm.io | bash -s stable --ruby

  • then install jekyll:
    gem install jekyll
    gem install jekyll bundler

After installing Jekyll, run the following commands to preview the site:

  • build with jekyll build
  • serve the project with the command jekyll serve

You will now be able to access the help pages locally at http://0.0.0.0:4000/help or localhost:4000 (default configuration). After the website is built for the first time, you should only need to save the file, wait a second or two for it to rebuild automatically (check the terminal window where you ran jekyll serve), then refresh the page to see any changes.

Maintainer

Kelly