-
-
Notifications
You must be signed in to change notification settings - Fork 508
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migrate documentation from Relishapp to Github page #968
base: master
Are you sure you want to change the base?
Conversation
These look beautiful. Thank you for taking this on. |
We will have to change link in command output too. |
Right, these: Line 198 in 5c0ded8
With a link like https://benoittgt.github.io/vcr/#/record_modes/new_episodes?id=new_episodes ...since I can't seem to locate any "version-specific docs" link there. |
I need to do extra work for the version. I will see what I can do. |
@benoittgt At any rate, people will have to upgrade to new code to enjoy the new links, anyway, so no rush. |
@benoittgt As an update, I have merged #973 which uses the benoittgt GitHub Pages site for docs, in the RubyGems metadata section for homepage, which will be reflected on that site with the next release. |
Ok thanks ! To accept this current PR we want to have the version switcher? Anything else? :) |
@benoittgt I think we are amazing if we have a version switcher. |
@olleolleolle I'm sorry to jump in out of the blue, but would this be worth merging on the basis of "perfect is the enemy of done," after which a version switcher could be added? I have personally found the new documentation site to be very helpful, especially compared to the unfortunately dead relishapp docs. |
With by default light
I am not super fan of having a package.json but I do have other idea
For the version switcher. There is a nice proposal on this repository with the result. It is a little bit detailed in an article. I started looking at it, but it requires some work. And probably we need to create "stable" branch OR limit the documentation per tag. If we want something more dynamic, we need to follow imgproxy code. |
@benoittgt ❤️❤️❤️ That's fantastic! |
@benoittgt I dropped Ruby 2.6 from CI and gemspec, now, so if you rebase, we ought to be green. |
https://github.com/vcr/vcr/blob/master/Rakefile#L33 This code still exists, and I guess could get some automation love. @benoittgt None of those scripts are in use, right? I ought to be able to remove them, no replacement. EDIT: Update - we no longer have those Rake tasks or Relish app code around. |
Recently Relishapp was sadly broken. It is not possible to make it easily work again.
To let user access to a new documentation I tried to migrate all documentation to Github page.
Tasks done in this PR:
.feature
file using https://github.com/raviqqe/gherkin2markdownA demo with this code can be seen here: https://benoittgt.github.io/vcr/#/
There is still tasks that should be addressed. See list here: #967 (comment). But I think we should already offer a documentation.
Sorry for the not super well commit story.
Close: #967