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

Change links under "Docs" menu on https://cucumber.io/docs #433

Closed
mlvandijk opened this issue Dec 29, 2019 · 6 comments
Closed

Change links under "Docs" menu on https://cucumber.io/docs #433

mlvandijk opened this issue Dec 29, 2019 · 6 comments
Assignees

Comments

@mlvandijk
Copy link
Member

Since adding the Cucumber docs to the SmartBear site, there is a menu option "Docs" that offers several links to the actual docs:

  1. The arrow > goes to https://cucumber.io/docs/cucumber/ - which is a good place to start
  2. Installation
  3. Gherkin Syntax
  4. API Docs -> goes to API automation tools that are not Cucumber
  5. 3rd Party Tools -> goes to tools that for the most part are not cucumber.

I think nr 4 and 5 should not be part of this high level menu.
Instead I would like to include:

  • Guides and/or 10 minute tutorial
  • Community and/or FAQ
    Alternatively, "Cucumber" could be one of the links and the arrow > could go to docs landing page.

If we have data on which pages people look for that would also be helpful.

@annabaker
Copy link
Member

I searched in IntelliJ, and found 100+ matches for where this HTML should be changed. In addition, all of the .html files are read-only -- is there a single location where we can update this?

Another opinion: I feel the FAQ should be moved out of the "Community" section and into its own section, with two children: Cucumber FAQ and FAQ about related tools. It is easier to access by end-users this way. My $0.02.

@mlvandijk
Copy link
Member Author

I agree with you second point. Feel free to create a PR for that, would very much appreciate it.

I'm not actually sure where this menu is created tbh; it might be in the SmartBear website and we might be unable to change it. html is likely generated somehow (@aslakhellesoy will know more about the technical setup of how the frontend is created, I just do content ;) )

@helenjoscott
Copy link
Contributor

Hi @mlvandijk, are you thinking something like this? Would you want the API or 3rd Party links to be anywhere in this menu?

Screenshot 2020-10-14 at 09 14 27

@helenjoscott helenjoscott self-assigned this Oct 14, 2020
@mlvandijk
Copy link
Member Author

@helenjoscott Yes, something like that. I don't think API and 3rd party links should be in this menu. Note I'm not sure that these links can be changed in this project; they might have to be changed in the SmartBear website.

Also I agree with @annabaker that FAQ should be taken out of Community. But for restructuring please have a look at #474

@helenjoscott
Copy link
Contributor

Well I mocked it up and I seem to have managed to change them... I think. I can do a PR and someone with some knowledge (which isn't me) can take a look?

helenjoscott added a commit to helenjoscott/docs.cucumber.io that referenced this issue Oct 14, 2020
Removed API and 3rd Party Tools
Added 10 Minute Tutorial and Guides
mlvandijk added a commit that referenced this issue Oct 18, 2020
* #433 - Changed links in menu
Removed API and 3rd Party Tools
Added 10 Minute Tutorial and Guides

* #284 - Added 'Does Cucumber-JV support Kotlin?'

Co-authored-by: Marit van Dijk <[email protected]>
@mlvandijk
Copy link
Member Author

Closed by #528

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

No branches or pull requests

3 participants