Code Monkey home page Code Monkey logo

manageiq.org's Introduction

ManageIQ.org website

CI

This is primarily a Jekyll site, with some tools to collect and pre-process documentation from multiple sources.

How To Contribute

In general:

  1. Fork this repo
  2. Create a feature branch
  3. Submit a pull request

The site content has different sources.

Source Overview

Directory Contents
dest where the site is built locally
exe Command line tool (Thor)
lib Ruby code for CLI, processing docs, etc.
site Site content
test Tests for Ruby code

Documentation groups

The documentation for ManageIQ comes from several sources which are continuously improved. Contributions are welcome to each of these, here's where you can help:

Getting started

Docs in the getting started group are part of this repo, find them under site/docs/get-started

User reference

The user reference docs are hosted at https://github.com/ManageIQ/manageiq-documentation.

There are two formats that the documentation can be written in:

  • For releases kasparov and newer, they are written in markdown and build like the rest of the project.
  • For releases jansa and prior (legacy), they are written in Asciidoc and organized in AsciiBinder.

But regardless of the format they are sourced as, they are built in a temp directory and copied (rsync) to /site/docs/reference/latest.

API Docs

The API Docs are hosted in the same repo as the User Reference, under the api directory

Developer Guides

These guides describe how to work with and contribute to the source code of ManageIQ itself. They are found in this repo: https://github.com/ManageIQ/guides.

Before the Jekyll site is built, YAML front matter is added to each page of the guides, if that page does not already have it.

Currently this is included as a Git submodule.

Automation book

Peter McGowan is working on a book covering the Automation features of ManageIQ. You can find the source for that book here: https://github.com/pemcg/mastering-automation-in-cloudforms-and-manageiq. However, this content is hosted on Gitbook and only linked to from the site.

Working Locally

$ exe/miq

miq build <all|guides|site|reference>   # Build or process an aspect of the site
miq help [COMMAND]                      # Describe available commands or one specific command
miq reset <all|guides|site|reference>   # Reset repo(s) to clean state
miq serve                               # Does Jekyll serve with appropriate args
miq update <all|guides|site|reference>  # Pull changes from origin repos

Working with large images

Images (img) in documents and blog posts should be "responsive" by default, that is their width should not exceed the width of their container. Add the .large_img class to give large images zoomability.

Questions / Suggestions?

manageiq.org's People

Contributors

agrare avatar bdunne avatar chargio avatar chessbyte avatar chrisarcand avatar connorjgilchrist avatar cybette avatar d-m-u avatar dneary avatar epwinchell avatar fryguy avatar garrett avatar geertj avatar hayesr avatar himdel avatar imtayadeway avatar jasonbrooks avatar johnmark avatar jprause avatar jrafanie avatar jvlcek avatar kbrock avatar matthewd avatar mfeifer avatar mscherer avatar nicklamuro avatar romanblanco avatar simaishi avatar skateman avatar thadjennings avatar

Stargazers

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

Watchers

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

manageiq.org's Issues

Fix favicon in ManageIQ images

The CFME/ManageIQ nightlies have a favicon which is different from manageiq.org - it would be great to make the two identical.

Quickstart

We need a good first use walkthrough, so that people, after setting up ManageIQ (covered in the download section's quick setup information) can actually use ManageIQ to achieve tasks.

It must be task-based, and it is more-than-acceptable (welcomed, really) to link to other documents when appropriate.

Move "next steps" to download

Next steps was designed for a simple download. As our download got several times more complex (out of necessity) versus the early mockups, I commented out the "next steps" section.

Most of it can probably be reused, at least in concept, on the download pages.

markdown engine: investigate Kramdown instead of RedCarpet

At a first look, it seems Kramdown may suit our needs better.

Kramdown supports definition lists, metadata, and a few things that RedCarpet doesn't seem to support natively. It, like RedCarpet, supports GitHub flavored Markdown pretty well — as well as other Markdown extensions.

See http://kramdown.gettalong.org/quickref.html for a quick overview, or visit http://kramdown.gettalong.org/syntax.html for lots more syntax info.

In addition, Kramdown supports converting from HTML to Kramdown-ified Markdown too, which could be a good way to port the content from various sources (such as DocBook → HTML → Kramdown's Markdown).

ask.manageiq.org - email confirmation goes to spam on gmail

From issue #35 :

@Fryguy said:

Ok, so I tried logging in with my gmail (Google+) account, and I seem to have gotten to where it send me a confirmation email. So I waited and waited...and realized maybe its in spam. Sure enough there it was. I think the problem is that the "from" email address is "[email protected]", and the details on why it was marked as spam are here. I'm happy to see that @dneary notified a Evgeny in his last comment, otherwise, I'd be super confused.

Would it be possible to have the email come from [email protected] or something?

change 'stage.manageiq.org' to 'manageiq.org' in talk.manageiq.org's embedding settings

Important: Do not address this issue until launch!

We need to change stage.manageiq.org to manageiq.org in the embedding section of the settings in the admin part of talk.manage.org when officially launching.

As the comments need to be whitelisted, changing this before changing the site will break commenting on the staging server... so don't change this until the last minute.

Facebook page

What's the Facebook page for ManageIQ? If we're going to add it back to the site, I need the link.

Split site.sass into smaller files

As it stands, site.sass is most of the style of the site.

It should be split into both generic code chunks as well as ManageIQ specific blocks of SASS.

“About ManageIQ” subsection

Reference URL: http://stage.manageiq.org/documentation/

Currently, under "About ManageIQ", we have a few subsections, including "ManageIQ's audience", "A perfect fit", and "Markitecture".

I think these subsections should probably be combined.

We probably do want to think about what these subsections are trying to achieve and answer the questions that each one is implying.

That is:

  1. Who is ManageIQ for?
  2. How does it solve things for the people of this audience?
  3. How does it fit into the greater ecosystem of all related products? (Note: From Red Hat & Open Source as well as proprietary ones from various sources.)

We can have sub-pages that address these points in depth and/or provide a medium-depth answer here (with the very shallow answers being on the front page). It would be possible to nuke this from the docs page and just have in-depth answers on sub-pages that are linked only from the front page (or other appropriate locations).

blog comments?

One of the reasons I've mentioned Discourse several times in the past is... not only is it a good, open source forum, it also allows the top comments on a forum thread to be syndicated elsewhere. Also, it can consume an RSS/Atom feed and create new forum posts too.

These two features, together, mean that we can have dynamic commenting on the site and kick it over to the forum for more discussion.

So, this is possible, but not necessary. We don't have to have comments... but if we do, this would be the way to do it.

@johnmark: What do you think about comments on the blog posts?

Enable the wiki in the manageiq module

Community projects need wikis so that community members can share content without permission from a central authority. ManageIQ will need a wiki, and we have discussed since quite early in the process using the github wiki to avoid maintaining Yet Another Piece of Infrastructure.

Please enable the wiki for the manageiq module so that we can start seeding it with content after the release.

(/cc @garrett, @johnmark, @Fryguy since there has apparently been some confusion on this point).

Community page content reorganization

As outlined in #60 (comment), the community page content should be reordered and possibly presented in a different manner.

Summary

  1. Make the headers reflect the type of content
  2. Group the content differently

There are three different themes in the first two content blocks:

  1. Communicate / Interact / Participate — communication with the community of people using the software and the people working on building the software
  2. Educate / Document — the act of writing for people using the software
  3. Develop / Build — producing the software for people to use

(And then there's block 4, which is community governance and licenses. But that's not up for debate, as it's really clear.)

The community page should be restructured to be 3+1 blocks instead of 2+1.

Also, it should probably look better than its current incarnation of just a list of links. But rewriting text and visual formatting may be enough, as adding graphics takes time and sometimes does not add anything. (See the removal of icons in buttons and menus of GNOME for an example here.)

Please understand: The community page itself is not for documentation on using the software, as that is the role of the documentation section, but for materials on community-related participation.

Formalize development requirements

  • Ruby development environment
  • Ruby Gems
  • Bundler
  • C++ compiler
  • Curl development

Linux

On Fedora/RHEL/CentOS, the requirements can be installed with a yum command:

sudo yum install -y ruby-devel rubygems-devel gcc-c++ curl-devel rubygem-bundler

OS X

Macs need Xcode installed, plus anything from the above list that's not included by default (such as Bundler, possibly).

Xcode can be downloaded from the Apple store for OS X at:
https://itunes.apple.com/us/app/xcode/id497799835

Once Xcode is installed, what else is needed for OS X?

Credit Rackspace for their hosting

We need to credit Rackspace for their generous support and hosting services for the project. There are a few places we could do this - in the "Supporters" section (underneath project members) or on our "Community" page.

ask.manageiq.org integration

Quoting @dneary, from gitlab:

We will use ask.manageiq.org as or Q&A site, using AskBot.

We will need to:

  • Expose the site on the front page and community page ("Ask a question" or "Ask for help")
  • Expose the site to the AskBot developers so that they can theme the site to fit in with manageiq.org
  • Ensure that we have people internally asking & answering questions ASAP, so that the site is not empty at launch

Support OS X

There's interest in adding support for OS X.

In an initial try, there's an issue with UTF-8 in a file. We may have to change the file or list versions of Ruby that are supported. (Even without changes, it would be useful to list requirements. See issue #3.)

We'd also need to update the documentation (and possibly setup.sh) to include OS X support.

What is the preferred method to get a Ruby on Rails development environment up and running on OS X?

Integrate YouTube videos into the website

We have two main options:

  • Linking
  • Embedding

(Ah, the classic include-media-in-a-document choices…)

In some cases, one might be preferable over the other, but I think embedding probably makes the most sense.

Fix mobile rendering of the site on non-front-pages

Padding for small-width pages is non-existent and — even worse — negative for markdown-generated pages.

(I think this is a side-effect of backporting the simple site. Oops. It should be easy enough to fix.)

differentiation between "ask" and "talk"

With regard to #29 & #30:

How do we message the difference between the "ask" and "talk" sites?

In most people's minds, having two is quite redundant. People can (and often do) ask and answer stuff in a forum.

It is super-important to get this messaged correctly, else people will wind up in the wrong place and will be confused (and the resulting site will be full of the wrong type of conversation if this is a common occurance).


attn: @dneary @johnmark

Terms of use

Use http://openstack.redhat.com/Terms_of_use for the text, then run s/RDO/ManageIQ/.

Where should this live? documentation/terms-of-use? or just /terms-of-use in the root?

Also, where does this need to be linked? I guess in the footer? Anywhere else?

icons on the front page

Right now, they're placeholders. Some might be okay, but they should be revisited and at least the fire placeholder should be reconsidered.

If we can use icons from Font Awesome, that's great... but I'd even consider mixing in an SVG if nothing fits (and there's a metaphor that works).

Google+ page

What's the link for the ManageIQ Google+ page?

I'll add it to the footer next to "Twitter" (and possibly Facebook, once I get that link too — see #16).

Change HAML pages to Markdown wherever possible

With the exception of the front page and dynamic pages like the download page, I think we can make most Markdown. It would be easier to edit and preview — especially on GitHub.

(Note: HAML pages use embedded Markdown currently. This would be a switch to pure Markdown when we can do so.)

content for "Market"

I need examples of extensions/plugins/marketlets/scripts/whatever-they're-called, so I could possibly help to build out the market area.

Update "edit this page on github" to work with imported git submodules

It would be nice if the link in the footer was made aware of the git submodule and could point to the correct place on github.

I'm adding this to last-minute milestone, but everything in the prepare-for-launch milestone has kind of shoved everything in the last-minute, as it's now the "last minute" timeframe... so this might have to just be a bug until after launch.

Update logos on Ask & Talk

The logos on the Ask & Talk sites should add "Q&A" and "Fourm" after the ManageIQ logo, in the Cabin font, so that someone visiting all the sites will be able to immediately tell the difference between them all.

Dashboard customization

I was told that having information on how to customized the dashboard.

Does documentation exist for this or does it need to be written? Is it critical for the launch?

Support Docker?

Should we support Docker?

We would need instructions on setting up Docker as well as Linux and OS X.

Also: A person would have to create the image manually, unless we upload the container to the index on every single change, unless we pass in the current directory in a server startup script, like I did for my simple server that is intended for MediaWiki… But then we should target Springboard and not ManageIQ specifically — however, the state of the gems wouldn't be preserved, so I think it would have a huge startup cost unless we figure out a workaround.

padding a the bottom of the page

Where did it go?

I guess merging in the simple site had a few small breakages. Simple to fix, but I need to fix it. Hence this little note to do so.

Convert DocBook to Markdown

I've been trying to convert DocBook to AsciiDoc, but it really seems that the support to do so — at least for our DocBook files — is quite lacking. (I have run into the same issues that Dan Macpherson has.)

Converting to Markdown seems more robust and better supported... so now I am looking into variants of Markdown that would best allow for GitHub-flavored extensions and other additional markup as one possible solution. (See issue #46)

Another option is to use MediaWiki's mockup... but I'm trying to use Markdown instead, as that's what the team is already familiar with and what is much more native on GitHub. (It renders Markdown beautifully already. I don't think that's the case for MediaWiki formatted files.)

During our call today, it was decided that we should probably go with an all-in-one page instead of separate pages per chapter. The headings would have IDs so each would be hot-link-able, enabling other pages to link directly to a section.

So, no matter the format we choose, whether AsciiDoc or Markdown, it should be in one page and have header IDs.

talk.manageiq.org integration

Quoting @dneary, from gitlab:

Developer and user forums will go through Discourse, on the subsite talk.manageiq.org

We need to:

  • Add a "Forums" block to the front page, community page, and page footer to ensure people can find them
  • Expose the website to Jeff Atwood at a point where it's sufficiently advanced that he can theme the Discourse site to fit in
  • Ensure that developer discussion happens on the forum ASAP (so that at launch it's not empty)

IRC info

What are the IRC details (server, channel, some text with how to connect)?

Do we want to show this on the site? If so, I suggest a link at the bottom, next to email.

Frequently Asked Questions (FAQ)

We have a placeholder for Frequently Asked Questions in the documentation section.

Is anyone working on this yet? (If not, can we get someone working on this?)

If we keep it short, we can put it on the documentation section. If there are more questions (or detailed answers are needed), it should go on its own page.

Meet the team

If we're going to do this by launch, we need proper content for this.

That means a:

  • name
  • photo
  • summary
  • title for the person in relation to the ManageIQ project
  • contact links (twitter, URL, etc.)

This is needed for every person involved.

(Note: This should probably be a programmatically generated page, based on content in a YML file in data and images under source/images/team/*png)

Download & install content

We need content that's more complete for the download and install steps.

I know @dneary was working on this, but input from @johnmark, and @mfeifer would be very welcome too, as this is a critical part of the site, and the 2nd step in getting people using ManageIQ (the first being awareness of the project/software/website, naturally).

location for videos... YouTube?

@mfeifer mentioned to me in IRC that there are open questions about video hosting.

I seem to remember that we will probably use YouTube for hosting. However, that means we need to have an account and everything may entail.

Create documentation for how to translate/localize ManageIQ

Quoth @dneary:

We will need to check whether there is a way to handle translations already with the developers, if there isn't then it may need to be a higher priority (as that is often the quickest way for newcomers to productively contribute to a community project).

...So:

  1. Is ManageIQ translatable?
  2. Are there existing docs on how to translate it?

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.