Normalize EOL symbol for the platform docs #55689
Merged
Conversation
This file contains 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
mshustov
added
chore
Team:Core
|
Pinging @elastic/kibana-platform (Team:Platform) |
mshustov
changed the title
mshustov
commented
Jan 23, 2020
| @@ -83,7 +83,7 @@ const runBuildTypes = async () => { | |||
| const runApiDocumenter = async (folder: string) => { | |||
| await execa( | |||
| 'api-documenter', | |||
| ['markdown', '-i', `./build/${folder}`, '-o', `./docs/development/core/${folder}`], | |||
| ['generate', '-i', `./build/${folder}`, '-o', `./docs/development/core/${folder}`], | |||
There was a problem hiding this comment.
I believe the platform team should be the owner of this script.
3 tasks
pgayvallet
approved these changes
Jan 24, 2020
|
Great, this is finally done. Merging it might be a little challenging though, as any documentation update merged on master will create conflicts in the PR. |
rudolf
approved these changes
Jan 24, 2020
mshustov
force-pushed
the
normalize-eol
branch
from
88c7a09 to
cbb32c4
Compare
💔 Build FailedHistory
To update your PR or re-run it, just comment with: |
mshustov
added a commit
to mshustov/kibana
that referenced
this pull request
Jan 27, 2020
* use api-extractor generate command with api-documenter config * update docs
mshustov
added a commit
to mshustov/kibana
that referenced
this pull request
Jan 27, 2020
This reverts commit 1ea175e.
mshustov
added a commit
that referenced
this pull request
Jan 27, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Closes #53761
Use
api-documenter generatethat allows to specifyapi-documenter.jsonconfig withnewlineKind: 'lf'.I also tried another approach with adding
docs/development/core/** text eol=lfto.gitattributesbut it breaksgit diffand logs an annoying warningwarning: CRLF will be replaced by LF in docs/development/core/server/kibana-plugin-server.configpath.md. The file will have its original line endings in your working directory.