Name: TessGiWebsite
Owner: TESS Guest Investigator Program
Description: Website for the TESS Guest Investigator Office.
Created: 2017-04-17 18:39:23.0
Updated: 2018-03-31 17:26:11.0
Pushed: 2018-03-31 17:26:59.0
Homepage: http://tessgi.github.io/TessGiWebsite/
Size: 696289
Language: CSS
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
The website for astronomers using NASA's TESS space telescope.
Live URL: Nothing for now
Test URL: http://tessgi.github.io/TessGiWebsite/
TESS's Guest Investigator Program Website can be edited
by modifying the text files in the content sub-directory of this repository,
compiling them using make html (or make devserver),
and sending them to the server using make live.
The essential commands for Kepler/K2 staff are:
t clone https://github.com/tessgi/TessGiWebsite.git
TessGiWebsite
ke devserver
refox http://localhost:8000
ke changes in the `content` sub-directory
d preview them at http://localhost:8000
t add content/file-you-changed.md
t commit -m 'Explain your change'
t push
ke live
In what follows these steps are explained in more detail.
The first step to start editing the website is to clone the website's main git repository onto your local machine, e.g. using:
clone https://github.com/tessgi/TessGiWebsite.git
If you are going to make changes to the website, you will need to ask the TESS GI Office to give your GitHub account write permissions to this repository.
Compiling the website requires a working environment of either Python 2 or 3 to be installed, e.g. using the Anaconda Python Distribution.
You will also need to ensure that the pelican, markdown, beautifulsoup4,
and ghp-import Python packages are installed,
e.g. using the pip package installer:
p install pelican markdown beautifulsoup4 ghp-import
Note that if markdown is not installed, you will only get a very cryptic warning message ("No valid files found in content.") when compiling the website below.
The website content is stored as a collection of text files
in the content sub-directory of this repository,
which is where all changes must be made.
Most of these content files are formatted using the MarkDown text format (see cheat sheet here), which will automatically be compiled into HTML code using a template (to be explained in step 4). You may also use HTML tags directly in the content files, but this should only be necessary in a small number of cases where very precise control over the layout is required.
Note that the website's template is based on the flatly bootstrap theme.
This means that you can use all the html elements and classes
which are demonstrated at https://bootswatch.com/flatly.
In addition, you can also use all the standard bootstrap css classes.
After editing the content, you will usually want to preview your changes by compiling the website into HTML format and viewing them in your browser.
The easiest way to do this is to type make devserver in the root of this
repository, which will start a local server in the background
that will serve the website at http://localhost:8000
(type this address in the url bar of your browser to preview the website).
The server is fast and will auto-compile every time you change a content file,
however note that it does not create a full
version of the front page:
you need to perform a full build using make html to preview the front page.
When you are done, you can kill the background server process using make stopserver.
When you are happy with the changes made, you can make them live. This is a 3-step process.
First, make sure you update the repository to include changes others have made (and resolve any conflicts), e.g. using
t pull
Second, commit and push your own changes to the KeplerGO git repository so they are available to others. For example, if you changed the Helpdesk page, you would type:
t add content/pages/helpdesk.md`
t commit -m 'Changed the helpdesk e-mail address'
t push
Finally, you can now send the new HTML-compiled version of the website
to the dev webserver.
This is done by typing make github.
Note that it may take up to 5-10 minutes for changes to become visible after
make github completed.
We want to maintain a consistent style across the website. Rules include
The Makefile provides the following useful commands:
make html to compile all pages and store them under output/.make quick to compile only pages that have changed. This is faster than make html but will cause the front and news pages to be incomplete.make devserver to start a development webserver on your local machine at http://localhost:8000, which will auto-compile a page when you make a change. This too causes the frontpage to be empty unless you call make html.make github to send the compiled HTML files to the development server.Note: make quick and make devserver both use agressive caching which allows the website to be built quickly, but causes the listing of news items to be missing from the front page (output/index.html). You need to call make html if you care about a preview of the front page. Calling make github or make live automatically triggers make html.
This site started off as the Kepler/K2 website, created by Thomas Barclay, Geert Barentsen, and Knicole Colón for the Kepler/K2 Guest Observer Office at NASA Ames.
The TESS GI website is developed and maintained by Thomas Barclay, Elisa Quintana and Josh Schlieder at NASA Goddard
Created using the Pelican package and the pelican-bootstrap3 theme.
coming at a later date