Skip to content
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

New Documentation Website (née #755) #967

Open
olleolleolle opened this issue Mar 1, 2023 · 10 comments · May be fixed by #968
Open

New Documentation Website (née #755) #967

olleolleolle opened this issue Mar 1, 2023 · 10 comments · May be fixed by #968

Comments

@olleolleolle
Copy link
Member

The Relish website stopped being served.

Describe the solution you'd like

It would be nice to have a rendered version of the Cucumber test results somewhere.

Describe alternatives you've considered

See #755.

Additional context

See #966

@benoittgt
Copy link

I am not able to the get the work done here by @nicolasiensen #755 (comment) but gherkin2markdown looks promising with the previous iteration. https://nicolasiensen.gitbook.io/vcr-documentation/

I will probably start to look at it but I cannot promise anything in term of due date.

@benoittgt
Copy link

benoittgt commented Mar 1, 2023

Gitbook with gherkin2markdown is not very scriptable and painfull to use (result after 2h of painfull UI). But I just start working with docsify.js and it looks much more promising. With an hosting on github page. I will try to show sometime tomorrow for VCR with in mine that it should work for RSpec after.

cc @JonRowe

Also some infos

Unfortunately, I’m no longer in a position to be able to help. We have started some early conversations with SmartBear about releasing the IP for Cucumber, which I assume would include Relish’s codebase, but it’s early days.

My hope would be that we can open-source the code for Relish (in retrospect I wish we’d done this ages ago), find some sponsors for the hosting, and let it continue to serve as a platform for the RSpec team. At the very least they could salvage the rendering code to generate their own static documentation.

@benoittgt
Copy link

benoittgt commented Mar 2, 2023

Ok
First version here https://benoittgt.github.io/vcr

It requires some work for the version selection. Like the work done here imgproxy/imgproxy@c58f043#diff-479fbc16e4e62888e2b9b26b17afdb13dde049c126970f02c6fc3a3d234bc412R49-R69
Evil Martians and @palkan (as always) wrote something very interesting about it. I think this is the right direction.

  • Working version switcher menu
  • Sidebar menu with title of the page not name of the file 37ff527
  • Documentation that live inside /doc folder
  • Logo an little bit of styling
  • Checking all page for proper rendering (some page have invalid markdown)
  • Proper link for editing the doc (referring to feature file)
  • Add icon for supporting the project (basic link to project support page)
  • Automation
  • Check for build. See "lefthook" configuration in imgproxy.
  • Proper nav menu in mobile view. Look at https://docs.imgproxy.net/

@benoittgt
Copy link

@olleolleolle I completed few tasks. The current doc is going to the right direction for you ?

@olleolleolle
Copy link
Member Author

@benoittgt I like it, it's a little website!

@sshaw
Copy link

sshaw commented Mar 3, 2023

First version here https://benoittgt.github.io/vcr

Just had a look on mobile, Chrome 110 on Android and I couldn't find the nav. Having a look on desktop, I see the nav icon is at the bottom. I'd move it to the top. I guess that's the search box there now?

Screenshot_20230303-115247-419

@sshaw
Copy link

sshaw commented Mar 3, 2023

I'd also update this repo's site. Currently still pointing at relishapp.com/vcr/vcr/docs
Resources

@olleolleolle
Copy link
Member Author

@sshaw Thanks, anything can happen, let's give it one more day!

@benoittgt
Copy link

@sshaw yes I saw this nav issue. I will adresse it.

@olleolleolle
Copy link
Member Author

I have now pointed the VCR docs to Benoit's page. cc @sshaw @benoittgt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants