https://github.com/perfana/perfana-docs

Doucmentation for Perfana, the continuous performance testing dashboard
https://github.com/perfana/perfana-docs

Last synced: 17 days ago
JSON representation

Doucmentation for Perfana, the continuous performance testing dashboard

• Host: GitHub
• URL: https://github.com/perfana/perfana-docs
• Owner: perfana
• Created: 2020-02-15T12:59:50.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-23T15:13:21.000Z (12 months ago)
• Last Synced: 2024-11-09T04:15:20.933Z (2 months ago)
• Language: Ruby
• Size: 3.61 MB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Perfana Docs

## Local env

1. install ruby 2.7.8; use a ruby virtual environment such as ``chruby`` or ``rbenv`` and a ruby installer such as ``ruby-install`` or ``ruby-build``

   Note: don't use the Mac system version of Ruby in ``/usr/bin/ruby`` or `/usr/local/bin/ruby`

2. In the root of the project: ``gem install bundler:2.4.22``

3. Next: `bundler install`. Just like `npm install` this will install all the project's dependencies such as *jekyll*.  

## Local testing

To run locally, first edit the `_config.yml` file to use `theme:` instead of `remote_theme`:

```yml

#remote_theme: pmarsceill/just-the-docs

theme: "just-the-docs"

```

When done, put back the remote_theme before commit! 

This is to have it working correctly in github docs.

To run locally, use bundle: 

```sh

bundle exec jekyll serve

```

# for mac

Follow these steps to use specific Ruby version