Code Monkey home page Code Monkey logo

Comments (6)

mfeifer avatar mfeifer commented on August 28, 2024

Here's a link to what we have for CFME. https://access.redhat.com/site/documentation/en-US/CloudForms/3.0/html/Management_Engine_5.2_Insight_Guide/chap-Cloud_Intelligence.html#sect-Dashboard

Is this what you are looking for? If so, I could probably quickly make this in markdown..unless you have a tool for that.

from manageiq.org.

garrett avatar garrett commented on August 28, 2024

FWIW: A really quick way to convert web pages on the fly to Markdown is to do:

export DOC_URL="https://access.redhat.com/site/documentation/en-US/CloudForms/3.0/html/Management_Engine_5.2_Insight_Guide/chap-Cloud_Intelligence.html#sect-Dashboard"
curl $DOC_URL | pandoc -f html -t markdown_github > output.md

(You can, of course, just put the URL after curl instead of using variables. It's just split into two lines here using a variable to show the real command, without the URL getting in the way.)

This shell command relies on pandoc and curl being installed. curl is installed on most systems by default, but pandoc (which is a Swiss Army knife of document conversion) probably is not installed. It can be obtained via package management yum install -y pandoc or downloaded from http://johnmacfarlane.net/pandoc/

Apparently, there's a way to build an all-in-one binary too (just in case you're on CSB and can't install things, that would be a workaround).


...But it's much better to work from the original sources.

This is an export with numbered PNGs (instead of ones with proper filenames) and the section is split between multiple pages. And then there are parts of the web page we don't care about (header and footer, and probably the "report a bug" links).

It could be scrubbed and edited, but it's probably best to wait for the DocBook formatted documentation and work from that.

from manageiq.org.

garrett avatar garrett commented on August 28, 2024

BTW: If a URL is just http (instead of HTTPS), then pandoc itself can handle the URL. It can also output to a file with the -o flag.

Example:

pandoc -f html -t markdown_github http://manageiq.org/ -o output.md

from manageiq.org.

dneary avatar dneary commented on August 28, 2024

I think modifying the dashboard is probably not in the first 5 things people will do with this. Having this in a "Customizing your ManageIQ experience" or in a larger doc like the one Marianne pointed to, works for me.

I think what I'd like to see post launch (perhaps in blogs from our SAs?) is some "dashboard profiles" for different types of users. Not sure exactly how that would work, but instead of documenting adding & removing new widgets (which is what you pointed to), we could perhaps suggest certain widget bundles which together tell a story for a specific type of user. No idea what they might be.

from manageiq.org.

JPrause avatar JPrause commented on August 28, 2024

With the upcoming redesign of the website, this request seems not be relevant at this time,..can you close this issue @garrett

from manageiq.org.

Fryguy avatar Fryguy commented on August 28, 2024

Closing since the new website is now live. If you believe this to be in error, please reopen this issue.

from manageiq.org.

Related Issues (20)

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.