msradam / zikipedia

Translating z/OS jargon into English

Running Zikipedia on localhost (your workstation)

• Install the Ruby Programming Language

• Install dependencies:

gem install jekyll
gem install bundler
bundle install .
bundle update .

• Start Zikipedia on localhost.

bundle exec jekyll serve

 

 

Contribution Guidelines

 

z/OS Dictionary Contributions:

• Format all definitions as follows:

### ACRONYM/Term *(Expanded Acronym if necessary)*

{: .note }
> _Try to tie the ACRONYM/Term to something someone new to z/OS already knows to help demystify the concept._

* Give a clear and concise definition. Use terminology and concepts that someone who it new already might understand.

• The dictionary must be kept alphabetized.
• The dictionary markdown files are maintained in the dictionary folder.

Contributing to Guides

• How-to guides and step-by-step instructions should be contributed as guides.

• The Guides markdown files are maintained in the guides folder.

• New guides must include a metadata section at the top of the markdown file that defines the markdown file as a guide.

---
layout: default
parent: Guides
---

Contributing to References

• Quick references for commands and code syntax should be contributed as references.

• The References markdown files are maintained in the references folder.

• New referencs should include a metadata section at the top of the markdown file that defines the markdown file as a reference.

---
layout: default
parent: References
---

Pull Request

• When Contributions are ready, they must be made using a pull request.