GithubHelp home page GithubHelp logo

rexops / rexify-website Goto Github PK

View Code? Open in Web Editor NEW
14.0 9.0 31.0 7.15 MB

Website content and code for rexify.org

Home Page: https://www.rexify.org

CSS 65.06% Perl 34.94%
rex rexify hacktoberfest github-pages website

rexify-website's Introduction

Website content and code for rexify.org

The rexify website is powered by Statocles, and deployed to GitHub Pages.

Please see our Contributing Guide about how to contribute or work with it locally.

If you need help or have questions, please contact us on our various support channels.

rexify-website's People

Contributors

andrejzverev avatar arnisoph avatar chenryn avatar cpanxaoc avatar dracos avatar ehuelsmann avatar ferki avatar ipcjk avatar jfin avatar jj avatar krimdomu avatar maettu avatar maxhq avatar qingkunliu avatar rapenne-s avatar reneeb avatar sdondley avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

rexify-website's Issues

Example code in FAQ doesn't work

In the file content/docs/faq/index.md, the question "How can I run a block of code with one command?" has this example code:

$ rexify --use Rex::Misc::ShellBlock

That command no longer works. There's a ticket for it at RexOps/Rex#1201. I would submit a pull request to fix this answer, but I'm not sure what the example code should be changed to.

Use markdown in more places

I think it would make sense to use markdown in more places to ease authoring of new content, especially for the book :)

It might also be an option to reuse some existing content management system for it, but I think we can also just convert markdown into HTML internally.

Error create-module usage

html show rexify --create-module=Service::NTP
but the real command is rexify Service::NTP --create-module

Update installation instructions

The whole installation page could use a major overhaul. Just by skimming through it:

  • I believe the curl | perl - --sudo method should be discouraged (ref comment on #73)
  • rexops maintained repos can be cleaned up, mentioning distros which are already packaging rex on their own
  • for Mac OS X, homebrew can also be used (perhaps it can be considered as "distro packaging on their own" in its spirit)
  • the recommended method is proposed to be "install from CPAN", with the alternative being installing from source

I believe should really publish the recommended/preferred installation methods before some of those options go away.

Weird to use menu on touch devices

The navigation menu is showing submenus upon hover, which makes it weird to use them on e.g. a mobile phone (or I just don't know the proper gesture on touch screen :).

Probably it would be nice to see if can activate the submenu on a click instead of hover.

debian / ubuntu installation guide - use seperate list file

apt-get install apt-transport-https
echo 'deb https://rex.linux-files.org/ubuntu/ trusty rex' >> /etc/apt/sources.list.d/rex.list
wget -O - https://rex.linux-files.org/DPKG-GPG-KEY-REXIFY-REPO | apt-key add -
apt-get update
apt-get install rex

How to get support ?

http://www.rexify.org/support.html under 'Community Support' tells us to join the 'user group' , but I don't know what does that mean. Could the 'user group' be turned into a link to https://groups.google.com/forum/#!forum/rex-users if that's what you mean. (just as I later found on the left hand side of the page)

IMHO it would be also nice to link to http://stackoverflow.com/questions/tagged/rex from both the 'Community Support' entry and from the bottom left side and then monitor that tag on StackOverflow.
(Though I am not sure if it would not be better to have it on http://serverfault.com/ )

Tag questions on Server Fault

search lists all API version

When a search is executed, API results are listed twice, once for each API version:

Commands.pm (API version 1.3)
[...]
Commands.pm (API version 1.4)
[...]

I expect it would quickly get confusing as we release more versions, so I guess it would be nice/enough to only list the latest API version in search results.

The API version can be changed later on the linked page if needed.

Migrate website to GitHub pages

The website is the primary point for both new and existing Rex users to learn about the project, and to keep themselves up-to-date. It helps a lot if both the infrastructure and content of the website are simple and easy to maintain and edit.

Using GitHub pages for the website would help maintenance considerably:

  • plain git can be used to manage information/document lifecycle, simplifying both maintenance and
  • less worries about expiring certificates (also how to renew one, or who can renew it)
  • deployment is already automated
  • less worries about handling traffic spikes
  • can remove CDN from current setup (simplifies the project, and saves cost)
  • [add your own points here]

"Rescue" hidden content from the cms

there were a few placeholder pages before conversion, which were probably drafts, and I assume their content is in the database of the previous CMS

Those need to be checked and probably need to be imported

Use Statocles as site generator

Statocles is a static site generator, which was proposed earlier to use for managing website contents.

It seems it is capable of supporting many if not all of our use cases directly:

  • deploying to GitHub pages directly
  • generating static content from markdown files
  • theming/templating support (via Mojo::Template which is already used with current website)
  • generating documentation pages directly out of POD (like the API docs)

It is also written in Perl and maintained by a Rex user/contributor, which might help adoption and customization.

Steps

  • evaluate Statocles
    • deployment
    • site root flag for landing page
    • navbar
    • escape templates
    • convert html to markdown
    • generate index.html with dir content for menu buttons (docs/guides/etc.)
    • generate API docs from Rex PODs
  • migrate to Statocles
    • merge cms branch onto master
    • migrate to statocles on top of combined master (based on PoC in cms-to-statocles branch when done)
    • convert html documents to markdown
    • redirect rexify.org

Must have before migration

  • theming
  • templates
  • navigation bar
  • landing page
  • basic docs from current cms branch
    • faq
    • guides
    • release notes
    • other (backwards compatibility) (pr #80)
    • support (pr #81)
    • installation (pr #82)
    • getting started
    • static API docs (pr #83)
    • book (pr #79)
  • breadcrumb menu

No link to result

I just searched for http://www.rexify.org/search?q=timeout the resulting page told me there is something related in the API, but did not provide any link to read more about it. (and I really wanted to see if and how I might be able to set a short timeout for some of the commands)

Found here:
) Set the password for the sudo command. timeout($seconds) Set the timeout for the ssh

Document feature flags in Rex's POD

The goal here is to complete Rex's documentation and refer from the website to that document, eliminating the need for content/guide/feature_flags.md

Document packaging

To be documented

  • Project doesn't publish projects of its own
  • Project publishes release-tarballs to create packages from
  • Project helps packagers

Improve user experience on mobile

The site layout is not working so great on mobile browsers (reports from Android Chrome/Firefox). It would be nice to improve that, so patches are welcome! :)

Add 'trainings' contact details

There used to be scheduled trainings listed. There aren't any at this time, however, training contact details for those who want to receive trainings are to be added to the site.

Write a guide on how to add support for new platforms

A content idea is to describe how to add support for new platforms, like how to tell Rex to do the following:

  • bare minimum to run commands

    • connect (optionally non-SSH)
    • detect the shell
    • execute commands on that shell
  • manage systems

    • detect the OS
    • install packages on that OS
    • manage services on that OS

It should also be possible to do all that in external modules, not just within the core.

Improve syntax highlighting

On one hand, it would be nice to replace the current syntax highlighting based on highlight.js with Statocles' built-in highlighter plugin, if we can make that work.

On the other hand (and perhaps until the above replacement is being evaluated), we could also update highlight.js to a recent version, preferably one which only supports the languages we actually need to highlight on the rexify site (I guess Perl+Bash+YAML, not sure if anything else is presented as code which needs highlighting).

Todos:

  • upgrade highlight.js to latest version
  • optimize highlight.js to contain only languages which are actually necessary
  • replace highlight.js

Clarify requirements on 'Managed Hosts'

http://www.rexify.org/docs/guides/start_using__r__ex.html Under 'Managed Hosts'
there is a sentence that I think could be improved

"Rex doesn't try use any non-core Perl modules on the remote hosts, but some operating systems (e.g. RHEL/CentOS 7, Fedora 21) might not supply them out of the box. In this case you might need to install them first (currently this means the Digest::MD5 module)."

I think it would be better:

"Rex only uses core Perl modules on the remote hosts, but some operating systems (e.g. RHEL/CentOS 7, Fedora 21) might not supply all of them out of the box. In this case you might need to install them first (currently this means the Digest::MD5 module)."

And then IMHO, the "install" should be a link to another page, or it should open some hidden text, that explains how to install those modules on the OS-es where they are missing.

Create a more basic introduction about task automation software and frameworks

I would like to volunteer to help write a gentler introduction to Rex and the world of automated server/computer administration. Some basic topics I would include are:

  1. What is an "automation framework?"
  2. Why would you want to automate? What problems does automation solve?
  3. What are some typical use cases for automation?
  4. How to use Rex as a framework to help you automate tasks.

Basically, this intro would assume the person has little knowledge about server management software. Not being overly familiar with this class of software myself, I would need some general guidance but I will do all the writing.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.