Skip to content

Conversation

@bajtos
Copy link
Member

@bajtos bajtos commented Apr 24, 2018

I found it weird that our sidebar is listing "Testing your application" at top level, while most of other testing-related content is nested under "Best practices".

This pull request moves "Testing your application" to "Best practices" section and also adds a link to "Testing your extensions" to best practices.

Please consider this change as a quick improvement of the current status. In the future, we will probably want to revamp the sidebar and these best practices guides. Such bigger change is out of scope of this pull request though!

Checklist

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

@bajtos bajtos added this to the April 2018 milestone Apr 24, 2018
@bajtos bajtos self-assigned this Apr 24, 2018
@shimks
Copy link
Contributor

shimks commented Apr 24, 2018

Is this PR related to #1094? If it is, would you like to do the rest of its criteria in this PR as well?

@bajtos bajtos force-pushed the doc/improve-sidebar branch from 3372c28 to 41c9b6e Compare April 24, 2018 16:38
@bajtos
Copy link
Member Author

bajtos commented Apr 24, 2018

Is this PR related to #1094? If it is, would you like to do the rest of its criteria in this PR as well?

No, not related.

@shimks
Copy link
Contributor

shimks commented Apr 24, 2018

In that case, can we just make sure to check off > Move 'Testing your Application' under this section in #1094 once this PR lands? It's not a big deal though.

Copy link
Contributor

@shimks shimks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On second thought, I believe this is the first time we introduce two links that map to the same address (Testing-your-extension). Should we go forward with this?

@bajtos
Copy link
Member Author

bajtos commented Apr 26, 2018

On second thought, I believe this is the first time we introduce two links that map to the same address (Testing-your-extension). Should we go forward with this?

Why not? As I see it, the left sidebar acts as a signpost, allowing users to quickly find their way around our docs. I would like to see "Testing-your-extension" when looking for best practices (that's why it's under "Best practices"). Users learning about extensions and how to write them would like to find this document too, that's why it's under "Extending LoopBack 4" too.

@bajtos bajtos force-pushed the doc/improve-sidebar branch from 41c9b6e to 96b3119 Compare April 26, 2018 05:55
@bajtos bajtos merged commit 31d4cdd into master Apr 26, 2018
@bajtos bajtos removed the review label Apr 26, 2018
@bajtos bajtos deleted the doc/improve-sidebar branch April 26, 2018 07:15
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 this pull request may close these issues.

3 participants