docs: update Best Practices for DP3 release#1433
Merged
Conversation
bb7de61 to
5392957
Compare
shimks
reviewed
Jun 14, 2018
Contributor
shimks
left a comment
There was a problem hiding this comment.
LGTM (I haven't actually checked if there were any links you may have missed, but I trust you 😆). I wonder if we should take the opportunity with this PR to identify any pages that aren't on the sidebar and rename them to .shelved.md as well
docs/site/Best-practices.md
Outdated
| maintain. | ||
|
|
||
| Our best practice follows an "API first" and test-driven development approach: | ||
| 1. [**Defining the API using code-first approach**](./Defining-the-API-using-code-first-approach.md): |
Contributor
There was a problem hiding this comment.
I think we should change the listing from numberings to bullets. The content here has no logical flow from one another and I think it'd be misleading to number these.
Member
Author
There was a problem hiding this comment.
Good suggestion, applied.
5fa4b69 to
0270ef5
Compare
- Remove the following pages from the sidebar - `Defining the API using design-first approach` - `Testing the API` - `Implementing Features` - `Preparing the API for consumption` - Update the main Best Practices page to reflect the new content under this section - For pages removed from the sidebar, rename the files to have a `.shelved.md` suffix so we know in future the page was shelved and it's not having it in the sidebar is not an oversight. - Remove any references to shelved pages from docs and READMEs.
0270ef5 to
30cd908
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Remove the following pages from the sidebar
Defining the API using design-first approachTesting the APIImplementing FeaturesPreparing the API for consumptionUpdate the main Best Practices page to reflect the new content under
this section
For pages removed from the sidebar, rename the files to have a
.shelved.mdsuffix so we know in future the page was shelved andit's not having it in the sidebar is not an oversight.
Remove any references to shelved pages from docs and READMEs.
Close #1094.
This pull request depends on loopbackio/loopback.io#704 which is needed to fix update scripts used by loopback.io website.
Checklist
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated