Skip to content

Normalize EOL symbol for the platform docs#55689

Merged
mshustov merged 3 commits intoelastic:masterfrom
mshustov:normalize-eol
Jan 27, 2020
Merged

Normalize EOL symbol for the platform docs#55689
mshustov merged 3 commits intoelastic:masterfrom
mshustov:normalize-eol

Conversation

@mshustov
Copy link
Contributor

Summary

Closes #53761
Use api-documenter generate that allows to specify api-documenter.json config with newlineKind: 'lf'.

I also tried another approach with adding docs/development/core/** text eol=lf to .gitattributes but it breaks git diff and logs an annoying warning warning: 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.

@mshustov mshustov added chore Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// Feature:New Platform release_note:skip Skip the PR/issue when compiling release notes v7.7.0 labels Jan 23, 2020
@mshustov mshustov requested a review from a team as a code owner January 23, 2020 12:40
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-platform (Team:Platform)

@mshustov mshustov changed the title Normalize eol Normalize EOL for platform docs Jan 23, 2020
@mshustov mshustov requested a review from a team January 23, 2020 12:41
@mshustov mshustov changed the title Normalize EOL for platform docs Normalize EOL symbol for the platform docs 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}`],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe the platform team should be the owner of this script.

@pgayvallet
Copy link
Contributor

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.

Copy link
Contributor

@mistic mistic left a comment

Choose a reason for hiding this comment

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

lgtm

@mshustov mshustov merged commit 1ea175e into elastic:master Jan 27, 2020
@mshustov mshustov deleted the normalize-eol branch January 27, 2020 13:40
@kibanamachine
Copy link
Contributor

💔 Build Failed

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

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
mshustov added a commit that referenced this pull request Jan 27, 2020
@mshustov mshustov restored the normalize-eol branch January 27, 2020 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Feature:New Platform release_note:skip Skip the PR/issue when compiling release notes reverted Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// v7.7.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Core docs should have consistent EOL symbol

6 participants