Comments (5)
Also it'd be nice to have also older docs available on the website, not only the latest ones.
Something like:
- http://www.hawkular.org/hawkular-client-ruby/2.9.0/docs
- http://www.hawkular.org/hawkular-client-ruby/2.8.0/docs
- http://www.hawkular.org/hawkular-client-ruby/latest/docs
where latest
is in fact a symlink to the 2.9.0
, I am not sure if this works on github pages, but I can give it a try.
from hawkular-client-ruby.
link in item 3 above is 404..
and it should work on github as well since many users are reading the readme there.
from hawkular-client-ruby.
All the links are meant to be seen in the context of yardoc [1]. Check first link on the Readme[2]
I though it because of this other link[3] on the Changelog section[4]. Compare with the one in the documentation[2].
One way to avoid this (i think) would be to create a separate Readme.md for github.
[1] https://github.com/hawkular/hawkular-client-ruby#generate-documentation
[2] http://www.hawkular.org/hawkular-client-ruby/
[3] https://github.com/hawkular/hawkular-client-ruby/blob/master/file.CHANGES.html
[4] https://github.com/hawkular/hawkular-client-ruby#changelog
from hawkular-client-ruby.
Yes, item 3 doesn't work on github but works on the Hawkular documentation[1]. I didn't do that, I just followed that behavior.
I'll check what can be done.
[1] http://www.hawkular.org/hawkular-client-ruby/
from hawkular-client-ruby.
The links are meant to work from the context of the generated yardoc. Unfortunately, the rdoc on github doesn't support those github directives (ifdef::env-github[]..
) that work in adoc and markdown so we can't simple have one version for 2 purposes. Also now the documentation has to be generated and pushed to the gh-pages branch manually after the gem release and for the previous version the docs were missing.
So, we can make it work on the README on GitHub in the first place and also have a simple bash/ruby script that changes those 3 links in the generated yard docs, this would be done in travis only during the release. I guess, the release build can be recognized by some environmental variable in Travis, i.e we are building a tag and the tag has some x.y.z
format. Also the travis would need to push the result of the yardoc back to the gh-pages
branch, so there must be also some github token used + some magic.
If there is an easier way to do that, please leave a comment. Otherwise, I'll do the ^
from hawkular-client-ruby.
Related Issues (20)
- Return a more complete operation definition from inventory
- Another gsub does not work on URL issue HOT 8
- List operations sometimes fails
- get operation parameters via the official inventory way
- Add support for rates on query_stats mapping
- Support string metrics
- Allow to list tags in hawkular-metrics HOT 1
- ackBy no longer exists on alerts HOT 1
- Tenant handing in h-metrics 0.20 has changed
- Remove specs context metrics_0_16_ and leave only metric_services and metrics_0_8_0
- Add Test cases for XA Datasource to Datasource Add
- Add 'interval' field of alert conditions
- Add an option to query metrics based on tag only (regardless to type) HOT 2
- Support for multi-tenant operations HOT 6
- @inv_client.create_resource does not return path when resource already exists
- Add support for activesupport gem? HOT 12
- Consider replacing the websocket-client-simple gem with the same gem that is being used in the MiQ HOT 1
- Consider dropping support for v0.8 metrics HOT 5
- hawkular-website-bot's gh token lost the rights to push to the repo
- Incompatible with rest-client 2.1.0.rc1 ? HOT 2
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 hawkular-client-ruby.