Skip to content

Commit a7c4912

Browse files
authored
Defer to README for website dev
1 parent 2e2587c commit a7c4912

File tree

1 file changed

+2
-91
lines changed

1 file changed

+2
-91
lines changed

docs/infrastructure/website.rst

Lines changed: 2 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,6 @@
11
The Website
22
===========
33

4-
RITlug's website is powered by Github pages and stored in a repository in the RITlug Github organization.
5-
It is powered by vanilla Jekyll (no plugins) as Github pages does not allow plugins for security reasons.
6-
In order to update any aspect of the site, simply push or merge changes to the repository and the changes will take effect within a few minutes.
4+
RITlug's website is powered by GitHub Pages and stored in a repository in the RITlug Github organization.
75

8-
Announcements
9-
-------------
10-
11-
This is a quick rundown of how to post an announcement on the RITlug website.
12-
See also `Announcements <announcements.md>`__.
13-
14-
- Fork the repository to your own Github account (go to the RITlug repository and click "fork")
15-
- Clone the repository locally (if desired - you can also create it online)
16-
- Create a new file in announcements/\_posts named with the convention 2015-10-02-new-website.md
17-
- Add front matter to the file
18-
19-
::
20-
21-
---
22-
title: title of your announcement
23-
author: your name
24-
date: date, in the format 2015-10-03
25-
tags: [a, list, of tags] (optional)
26-
layout: post
27-
---
28-
29-
- Add a blank line, then type your announcement
30-
- Add the new file to git
31-
- Git commit
32-
- Git push to your repository
33-
- Open a pull request against the master branch (which is default) of the RITlug copy of the repository
34-
- When your pull is merged, the site will update within a few minutes
35-
36-
Talks
37-
-----
38-
39-
This follows the same process as announcements, with a couple of small tweaks:
40-
41-
- The files will be put in talks/\_posts
42-
- There is an extra line in the frontmatter called 'slides' which provides a link to where the slides for the talk can be viewed.
43-
This should be a URL, usually along the lines of /talks/your-talk-name.pdf if hosted on the RITlug site
44-
- The slides (if hosted on the RITlug site) should be put in the talks folder, prefaced with the year and semester. Something like 2015-fall-
45-
- If hosted on the RITlug site, the slides should also be committed
46-
47-
Site Source
48-
-----------
49-
50-
This is the structure of the source code for the site, e.g. where to find anything.
51-
Most of the structure should be pretty self explanatory.
52-
53-
The site uses Google's `Material Design Light template <http://getmdl.io>`__, version 1.0.
54-
The javascript is patched to allow for linking to other pages in the tab bar - a feature which should be built in in version 1.1.
55-
56-
The site follows a fairly typical Jekyll setup so you can refer to the Jekyll documentation.
57-
58-
Pointer: You can access announcements from within templates using {{ site.categories.announcements }} and talks using {{ site.categories.talks }}.
59-
60-
.. raw:: html
61-
62-
<pre>
63-
├── about.md - the about page (at /about.html)
64-
├── announcements
65-
│   ├── index.html
66-
│   └── _posts - all announcements posted on the site, in markdown format
67-
├── _config.yml
68-
├── connect.html
69-
├── css
70-
│   ├── material-brown-orange.css
71-
│   └── styles.css
72-
├── feeds
73-
│   └── latest.xml - ATOM feed
74-
├── img
75-
│   └── ritlug.png
76-
├── _includes - sections of the template. These are files included in templates in the _layouts directory.
77-
├── index.html
78-
├── js
79-
│   └── material.js
80-
├── _layouts - Available layouts. These are referred to in the pages themselves.
81-
│   ├── default.html
82-
│   ├── page.html
83-
│   └── post.html
84-
├── LICENSE
85-
├── README.md
86-
├── schedule.md
87-
└── talks
88-
├── index.html
89-
└── _posts - Talks posted on the site, in markdown format
90-
</pre>
91-
92-
Developing and Previewing
93-
-------------------------
94-
95-
`Refer to the README in the site repository <http://github.com/ritlug/ritlug.github.io>`__
6+
`Please refer to the README and CONTRIBUTING in the site repository <http://github.com/ritlug/ritlug.github.io>`__

0 commit comments

Comments
 (0)