This GitHub repo is for management of the Zowe website. It uses Github Pages to automatically publish any commits to the master branch of the repo to https://zowe.org. GitHub Pages uses Jekyll to publish this site from the content in your markdown files in this repo. For more details see GitHub Flavored Markdown.It is important to note that the links and content within the .md files require preprocessing and publication on zowe.org before they become fully functional. Attempting to access these links directly from the repository will render them non-operational.
Most site updates can be made without changing the markdown files, but adjusting the config settings. This includes doing new releases and changing the URLs to other resources.
The primary page content is in index.md. The overall layout is in _layouts/default.html, and css and image files are in assets.
To do a new release, add a new entry at the top of releases.yml right under the contents with this structure:
- version: 1.4.0 # version number
release_notes: https://zowe.github.io/docs-site/latest/getting-started/summaryofchanges.html#version-1-4-0-august-2019 # link to release notes
release_date: 2019-08-09 # release date in YYYY-MM-DD format
documentation: latest # path to docs ( minus the site url of https://docs.zowe.org )To add an announcement, add an entry like below in announcements.yml:
- announcement: This is my announcement
link: https://linktomyannouncementcalltoaction.orgEvents are not supposed to be added/modified manually, since they directly get synced with the OMP events calendar and updates only when the response of ICS feed changes through a PR by GitHub action.
The events are dynamically fetched from an ICS feed and parsed into the upcoming_events.yml.
If needed, the upcoming_events.yml can be manually updated by running cd _data and python ics-to-yml.py locally from the root directory.
Any site updates can be submitted as a pull request. We recommmend you create a fork of this repo and make changes there so you can preview them using GitHub Pages on your GitHub account. You can also develop locally with the following steps:
- Set up Jekyll on your computer
- Run
bundle installto install the GitHub Pages gem - Run
bundle exec jekyll serveto host the site locally (athttp://localhost:4000)
This repo aligns with the general Zowe project role definitions and License and Copyright guidance
Note: If your build script, after applying changes & doing a reload, is yielding an incorrect-looking UI, you could automate the closing & restarting of the script. Something like in Bash, while true; do timeout 25s bundle exec jekyll serve; done
Committers to this repo are defined in the COMMITTERS.csv file. You can request to the committers to become a committer after having successful commits to this repo. Committers are approved by an affirmative vote of the majority of committers.
You can direct questions about the website to the Zowe ZLC via email or on Slack.