If you wish to contribute to this repository please follow the guidelines below.
The first thing you need to do is to fork this repository into your own github account.
Then, clone it into your local machine:
$ git clone [email protected]:your-username/commons.openshift.orgAnd add the upstream remote to follow this repository's changes:
$ git remote add upstream [email protected]:openshift/commons.openshift.org
$ git fetch upstreamCurrently the most common task is to add members' information to the website, i.e., their logo, name, and url. You can check if any there's any logo waiting to be added on this repository's issues.
There exists a shell script and Java program within the repository that automates the addition of partners to OpenShift Commons. To use the script and program to add a partner, add an Issue where the body is in the following format:
Company: Company Name
URL: URL of Company's Website
Logo: URL of the Company's Logo (.jpg, .png, .svg, etc)
Capitalization of the fields does not matter, however each need to be on different lines,
spelled correctly, and be followed with :. A "TBD" can act as a placeholder for any of
the three fields. The program will simply skip the issue entirely until the TBD is revised.
Gathering pages summarizing information about a particular event can be generated automatically, based on information provided in the /data/gatherings.yml file. Details of the gathering event, sponsors and speakers are separated into three groups, explained below with in-line (comments in brackets). If not stated otherwise, the attribute is required and cannot be omitted for the page generation. However, if there are too many details omitted, the page may look plain; make sure to always check that the page is built to your liking, with the data provided in gatherings.yml.
Gatherings
Most data about individual event pages is stored here:
gatherings:
- name: "Seattle 2018" (unique; used to build the html page name and the menu link)
menu: "show" (is not in the site menu, if "show" is not here or the build date of this site is in future
compared with the event date below; if this item is absent, a landing page is not built -
this allows creating simple name/date/youtube_playlist_id records for past events with
exising YouTube playlists)
language: "English" (optional)
date: "2018-12-10" (once this is detected to be in past, compared with user's local time, obsolete page sections
are "disabled" and a notice is displayed)
time: "8:00 am - 5:30 pm"
youtube_playlist_id: "PLaR6Rq6Z4IqcrUvqDVPe5DxNvJp5s8UXC" (optional; an ID of a YouTube video playlist with
talks' recordings to be published on the Gatherings -> Videos page; also used to link the
playlist directly on the event page, once the event is over)
location: "Seattle, Washington"
google_maps_URL: >-
Start content here
(optional; alternate for the bottom map. Search for the location in Google Maps; Click "Share"; Select "Embed a map"; Copy/paste the entire HTML, including "<iframe...")
venue: "Washington Convention Center"
venue_URL: "" (optional; link to external venue page)
venue_address: "" (optional; adds lines to venue location on bottom of the page)
calendar_event_URL: "https://events.org/calendar_link.ical" (optional)
registration_text: "" (optional; replaces the default "Purchase tickets Now"/"Register Now")
registration_URL: "https://www.regonline.com/registration/Checkin.aspx?EventID=2246960"
pricing: (optional; if present, at least one label and price point is expected)
- label: "Early Bird"
price: "$99"
- label: "Standard"
price: "$149"
strikethrough: true (optional strikethrough boolean)
head_text: >- (optional; if present, overrides the header text)
Where users, partners, customers, contributors and upstream project leads come together to collaborate and work together on OpenShift.
lead_text: >- (optional; rendered as red intro text)
The OpenShift Commons Gathering will be co-located in Seattle with CNCF's KubeCon-NA!
info_text: >-
The OpenShift Commons Gathering brings together experts (...)
event_footer_text: >- (optional; this note is displayed below the event summary)
By being co-located in Seattle with KubeCon (...)
schedule_leadin: >- (optional: if present, will replace the lead-in text for the schedules)
The day will have a mix of keynotes, panels, ted-style talks, SIG break-out sessions, plenty of time to
network over local craft beers and be continuously fueled by local baristas.
videos_text: >- (optional; if present, will replace the text for the link to see gatherings videos)
See session video recordings from previous gatherings
invite_link: "" (optional; a link to invite a friend)
sponsors: (optional; sponsors are searched by name in participants.yml and in the sponsor list below)
- name: "sponsor"
sponsoring_URL: "foo" (optional; if present renders a button for sponsor registration)
sponsor_button_text: >- (optional; if present, overrides the sponsor application button text)
Apply to be a sponsor
overview_secion: (optional: if present, overrides the specified text)
where:
when:
price:
alternative_date_month:
alternative_date_day_of_week:
invite_a_friend:
headers: (optional; if present, overrides the text of the specified header)
overview: ""
sponsors: ""
schedule: ""
speakers: ""
venue: ""
schedule: (required; to be chronologically ordered - the template does not re-order)
- local_time: "8:00 am" (start time of the session)
session_name: "Registration Opens"
- local_time: "9:00 am"
session_name: "Welcome to the Commons: Making Collaboration that Works"
speakers: (optional; if present at least one speaker id is expected)
- id: "diane" (a unique id defined in speakers list below)
As mentioned in the comment above, this section is also used to reference YouTube playlists from past Gatherings. See the youtube_playlist_id key description above. The videos are taken from the playlists with relevant details such as video order in the list, video thumbnail, video name and video description; if you need to edit any of these, it should be done in the YouTube playlist itself. When there are any changes made on youTube to a playlist that is already published, the changes will be in effect after the Commons site is re-deployed, as the videos are fetched on build time. Please contact repository maintainers, if you don't feel like waiting for the next site re-build and would like to have the changes deployed as soon as possible.
If a whole landing page does not need to be built for an older gathering, a simple record, such as the following one, would result in publishing videos only from the given YouTube playlist on the Gatherings Videos page:
gatherings:
- name: "Austin 2017"
date: "2017-12-05"
youtube_playlist_id: "PLaR6Rq6Z4Iqe9xnafdhWdSgD-3qsWTm6K"
Speakers
Speaker details that are referenced by id in the schedule are kept in this form:
speakers:
- id: "speaker id" (unique)
name: "John Doe"
role: "Everyday Ninja"
company: "Doe Industries" (optional)
URL: "https://johndoe.org/about-me/" (optional)
intro: "John is" (optional; displays a pop up on hover with this text)
photo: "speakers/diane.jpg" (optional)
Sponsors
Sponsors are primarily searched by name in the /data/participants.yml list. If the sponsoring company is not yet a Commons participant, they can be defined here, using the same format.
sponsors:
- name: "sponsor" (unique)
link: "sponsorl_link"
logo: "sponsor-logos/sponsor.png"
After you've done your changes and tested them, you're ready to submit a Pull Request.
First, create a local branch on your local machine:
$ git checkout -b my-feature-branchThen, add, commit, and push your changes:
$ git add data/participants.yml
$ git add source/img/commons-logos/partner.png
$ git commit -m "docs: add partner-name (closes #123)"
$ git push origin my-feature-branchFinally, submit a submit a Pull Request