Protractor migration guide

[bencodezen]

This PR introduces a new Protractor Migration Guide to the References section to keep in parallel with the current information architecture of where "Migration Guide" lives.

[kevinold]

Looks great!

[jennifer-shehane]

1. Overall I'd like to see more inter-linking between our existing docs.

2. Please make sure to run npm start after updating all the url tags I suggested! I may have a typo in some of my suggestions and the build will catch and warn in the console if it's written to a dead link / incorrect.

3. I think the headings order is a bit strange. I suggest having "Introduction" as a main heading with the subsections - then Getting Started the next main section.

   To be clear, here's the hierarchy I'm suggesting. No reason to hide this great content that they can jump to.

   Before

   

   After

   

[bencodezen]

@jennifer-shehane Thanks so much for the thorough review! Learned a lot about how we use Hexo for Cypress documentation. Really appreciate it!

[jennifer-shehane]

@bencodezen There are some errors in the build. We eslint all of the code written in code blocks. The Buffer one is likely too aggressive, so you could add an eslint ignore comment line there.

[bencodezen]

Hey @jennifer-shehane! I think everything should be taken care of at this point. I've run a check on both npm start and npm run build locally and they seem to pass without any errors. Let me know if I missed anything else!

[bencodezen]

@amirrustam @jennifer-shehane I'm a bit stumped on this one. It keeps saying that it can't find the Japanese Sidebar equivalent of the Protractor Migration Guide, but the japanese folder is gitignored and shows up to be properly updated locally. Is there something we need to change in the CI process?

Here's the testing reference: https://dashboard.cypress.io/projects/ma3dkn/runs/12494/specs

[amirrustam]

@bencodezen so every language has it's own sidebar yml as well. For example, for Japanese, it is the ja.yml file. In it, you will the sidebar config for it.

[bencodezen]

@bencodezen so every language has it's own sidebar yml as well. For example, for Japanese, it is the ja.yml file. In it, you will the sidebar config for it.

🤦‍♂️ Didn't realize there was a Japanese sidebar in theme in addition to the source/ja folder which is where I assumed it was coming from. Thanks for the tip!

[jennifer-shehane]

@bencodezen I'm a little unclear about what is left to do with this PR. Did you have more work you wanted to do? Are you requiring a re-review from one of us?

[bencodezen]

@jennifer-shehane Thanks for checking in! It looks like we're going to put this on hold at the moment. I've removed you from the assignee and moving it to @amirrustam so it's no longer on your plate.

Dismissing my previous review as addressed

[amirrustam]

Will revive as part of the pending docs transition.