Comments (6)
please dont get me wrong tho. The docs are damn detailed and that's awesome. Just that having a lot of stuff on one page made it really difficult to search/skim thru to find stuff.
from rvm.
Sweet, I'm going to take this as a badge of honor :) I've been thinking over the past few weeks how we can improve the navigation and how to feature the more need-to-know sections of the doc. I agree that it's getting unwieldy but I'm worried about what could be left behind once the git repo is cloned, downloaded, uploaded to a Chef server, etc. So here's what I'm thinking:
- The README could easily have HTML a anchors to provide bookmark-ability. I've already started this in a temporary branch
- A rake task could be added that could either:
- Split the README into sections, update the wiki project repo and push it live (thus keeping things in sync) or
- Create a project-style GitHub site (https://fnichol.github.com/chef-rvm) that could use some JavaScript to provide section navigation--basically turning the README into a single page static app
Thoughts?
I'll keep this open in the meantime. There might be a generic pattern here for displaying cookbook docs...
from rvm.
OK, I've added a gh-pages branch which uses the most excellent DocumentUp:
http://fnichol.github.com/chef-rvm/
I think this is a good start :)
from rvm.
THANKS!
The docs look beautiful and are now easy to read.
from rvm.
DocumentUp is a pretty cool project, huh? Thanks!
from rvm.
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
from rvm.
Related Issues (20)
- user::install only supports one user HOT 1
- Is this project dead? HOT 7
- Deprecated Features HOT 2
- cannot load such file -- chef/mixin/command HOT 6
- gem_package recipe breaks chef_gem HOT 1
- Chef 12.17.5: could not find filename for attribute .gitkeep in cookbook rvm HOT 1
- How do you use this with chef solo? HOT 1
- Use --no-document instead of --no-rdoc --no-ri HOT 5
- Compatibility with Ubuntu 18.04 HOT 4
- Dangerfile should use failure instead of fail
- Remove .rubocop.yml with Dangerfile
- Update Changelog
- Run latest cookstyle
- Update builds to be parallel
- Could not parse `-/metadata.rb': undefined method `chef_version' HOT 2
- Support Modern Operating systems and have working dokken
- Error: cannot load such file -- rvm HOT 7
- rvm Chef 17 compatibility
- No resource, method, or local variable named `create_rvm_shell_chef_wrapper' for `Chef::Recipe "default"' HOT 2
- Dependency Dashboard
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from rvm.