8000 GitHub - tbazant/doc-o-o: Resources for the doc.opensuse.org website
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

tbazant/doc-o-o

 
 

Repository files navigation

doc.opensuse.org

Built with openSUSE Jekyll Theme.

Note that this repo only contains the home page of the site. Actual documents are from:

Development

Setting up the environment

sudo zypper in ruby ruby-devel ruby2.5-rubygem-bundler
bundle install

Making changes

Most changes, such as setting up a new product or guide, need to be made in the file _config.yml.

Building the navigation

make build

The resulting site will be in the _site directory.

Serving the navigation locally

make serve

Visit http://localhost:4000/ in your browser. Press Ctrl-C to stop serving the site.

Syncing the site

Prerequisites

Get the details about the SSH setup from someone in the know (e.g. @sknorr). Have your SSH key added to the .ssh/authorized_keys on the server.

Create a file publishusers within the local repository clone:

port=[SSH_PORT]
server=[SERVER]
userdoc=[USER_NAME_DOC]
userrn=[USER_NAME_RELEASE_NOTES]

Syncing documentation navigation

make upload

Syncing configuration for the release notes

make upload_rn_config

Building and syncing documentation content

  1. Clone the doc-sle repository locally: git clone https://github.com/SUSE/doc-sle
  2. Switch to the correct branch in the doc-sle repository: git -C /path/to/doc-sle checkout ...
  3. Open doc-build-script from this repository and make sure the following are set correctly (!!):
    • referenced guides ($guides)
    • the openSUSE Leap version number ($version)
  4. Run the script, from within this repo: ./doc-build-script /path/to/doc-sle

About

Resources for the doc.opensuse.org website

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 71.1%
  • HTML 12.8%
  • Makefile 11.9%
  • CSS 2.9%
  • Ruby 1.3%
0