Spelling docs by jsoref · Pull Request #37046 · elastic/elasticsearch

jsoref · 2018-12-31T15:01:28Z

This is the docs portion of #37035 split per @tvernum.

Since there were so few i.e.s here, I just left them, it isn't worth dropping, and for docs it seems more useful to leave them fixed.

There are probably merge conflicts, but realistically, as noted in the other PR, there will always be merge conflicts, this repo moves way too fast for large changes like this. I'll cross that bridge closer to when reviews are done.

--
Generated by https://github.com/jsoref/spelling f; to maintain your repo, please consider fchurn

jsoref · 2018-12-31T15:08:10Z

Changes from the original PR:

non docs/ / x-pack/docs commits were dropped (if people were watching, the way I did that was by deleting everything outside of docs/ / x-pack/docs and rebasing onto that, and then I forgot to remove that commit...; repeated for x-pack/docs because I didn't notice that right away)
height is now high per Spelling #37035 (comment)
I dropped pluggable-similarities.html per Spelling #37035 (comment)

elasticmachine · 2019-01-02T13:06:56Z

Pinging @elastic/es-docs

javanna · 2019-01-02T13:24:26Z

docs/java-rest/high-level/security/get-users.asciidoc

@nik9000 is there anything we can do do make this type of typo fail the docs build?

fwiw, I've written Travis integration for checkstyle: https://github.com/checkstyle/checkstyle/blob/master/.ci/test-spelling-unknown-words.sh

The same sort of thing can be done in any project. If you're not a fan of shell scripts, you can of course port the code to Java/Groovy.

checking the speeling would work, but in this specific case, given that :request: and :response: as well as :api: are some kind of keyword needed to fill the docs content, we could fail the build when anything other than the known words are used within those delimiters. I think :)

javanna · 2019-01-02T13:24:53Z

docs/java-rest/high-level/watcher/deactivate-watch.asciidoc

@nik9000 another one that we may want to catch

...org/elasticsearch/xpack/watcher/notification/email/attachment/HttpEmailAttachmentParser.java

...lasticsearch/xpack/watcher/notification/email/attachment/HttpEmailAttachmentParserTests.java

javanna · 2019-01-02T13:33:47Z

test this please

javanna · 2019-01-02T14:33:13Z

retest this please

javanna · 2019-01-02T14:33:56Z

I took the liberty to merge master in, as there were a couple of noisy tests causing failures that got muted on master meanwhile. Remember to pull from your own remote ;)

jsoref · 2019-01-02T16:09:12Z

I've rebased forward and cleaned out the files that were supposed to be renamed (my original hg repo properly had renames, but somewhere along the way the delete got lost)

javanna · 2019-01-02T16:41:05Z

retest this please

javanna · 2019-01-02T20:29:15Z

Seems like the build is failing due to some leftover references to the classes being renamed:

17:45:12 > Task :x-pack:plugin:watcher:compileJava FAILED
17:45:12 /var/lib/jenkins/workspace/elastic+elasticsearch+pull-request+docs-check/x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/Watcher.java:135: error: cannot find symbol
17:45:12 Build cache key for task ':x-pack:plugin:watcher:compileJava' is 41a0796ed15ec69b9a9522ef797ce2d6
17:45:12 Task ':x-pack:plugin:watcher:compileJava' is not up-to-date because:
17:45:12   No history is available.
17:45:12 All input files are considered out-of-date for incremental task ':x-pack:plugin:watcher:compileJava'.
17:45:12 Full recompilation is required because no incremental change information is available. This is usually caused by clean builds or changing compiler arguments.
17:45:12 import org.elasticsearch.xpack.watcher.notification.email.attachment.HttpEmailAttachementParser;
17:45:12 Compiling with JDK Java compiler API.
17:45:12 :x-pack:plugin:watcher:compileJava (Thread[Execution worker for ':' Thread 7,5,main]) completed. Took 1.143 secs.
17:45:12                                                                     ^
17:45:12   symbol:   class HttpEmailAttachementParser
17:45:12   location: package org.elasticsearch.xpack.watcher.notification.email.attachment
17:45:12 /var/lib/jenkins/workspace/elastic+elasticsearch+pull-request+docs-check/x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/Watcher.java:293: error: cannot find symbol
17:45:12         emailAttachmentParsers.put(HttpEmailAttachementParser.TYPE, new HttpEmailAttachementParser(httpClient, templateEngine));
17:45:12                                    ^
17:45:12   symbol:   variable HttpEmailAttachementParser
17:45:12   location: class Watcher
17:45:12 /var/lib/jenkins/workspace/elastic+elasticsearch+pull-request+docs-check/x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/Watcher.java:293: error: cannot find symbol
17:45:12         emailAttachmentParsers.put(HttpEmailAttachementParser.TYPE, new HttpEmailAttachementParser(httpClient, templateEngine));
17:45:12                                                                         ^
17:45:12   symbol:   class HttpEmailAttachementParser
17:45:12   location: class Watcher
17:45:12 /var/lib/jenkins/workspace/elastic+elasticsearch+pull-request+docs-check/x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/notification/email/attachment/HttpRequestAttachment.java:51: error: cannot find symbol
17:45:12                 .startObject(HttpEmailAttachementParser.TYPE)
17:45:12                              ^
17:45:12   symbol:   variable HttpEmailAttachementParser
17:45:12   location: class HttpRequestAttachment
17:45:12 /var/lib/jenkins/workspace/elastic+elasticsearch+pull-request+docs-check/x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/notification/email/attachment/HttpRequestAttachment.java:52: error: package HttpEmailAttachementParser.Fields does not exist
17:45:12                 .field(HttpEmailAttachementParser.Fields.REQUEST.getPreferredName(), requestTemplate, params);
17:45:12                                                         ^
17:45:12 /var/lib/jenkins/workspace/elastic+elasticsearch+pull-request+docs-check/x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/notification/email/attachment/HttpRequestAttachment.java:54: error: package HttpEmailAttachementParser.Fields does not exist
17:45:12             builder.field(HttpEmailAttachementParser.Fields.CONTENT_TYPE.getPreferredName(), contentType);
17:45:12                                                            ^
17:45:12 /var/lib/jenkins/workspace/elastic+elasticsearch+pull-request+docs-check/x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/notification/email/attachment/HttpRequestAttachment.java:57: error: package HttpEmailAttachementParser.Fields does not exist
17:45:12             builder.field(HttpEmailAttachementParser.Fields.INLINE.getPreferredName(), inline);
17:45:12                                                            ^
17:45:12 /var/lib/jenkins/workspace/elastic+elasticsearch+pull-request+docs-check/x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/notification/email/attachment/HttpRequestAttachment.java:68: error: cannot find symbol
17:45:12         return HttpEmailAttachementParser.TYPE;
17:45:12                ^
17:45:12   symbol:   variable HttpEmailAttachementParser
17:45:12   location: class HttpRequestAttachment
17:45:12 Note: Some input files use or override a deprecated API.
17:45:12 Note: Recompile with -Xlint:deprecation for details.
17:45:12 Note: Some input files use unchecked or unsafe operations.
17:45:12 Note: Recompile with -Xlint:unchecked for details.
17:45:12 8 errors
17:45:12 
17:45:12 FAILURE: Build failed with an exception.
17:45:12 219 actionable tasks: 218 executed, 1 up-to-date
17:45:12 
17:45:12 
17:45:12 * What went wrong:
17:45:12 Publishing build scan...
17:45:12 Execution failed for task ':x-pack:plugin:watcher:compileJava'.
17:45:12 > Compilation failed; see the compiler error output for details.

jsoref · 2019-01-02T21:02:46Z

Yeah, those commits aren't supposed to be there, I'm trying to figure out what I did wrong...

jsoref · 2019-01-02T21:43:35Z

docs/src/test/java/org/elasticsearch/smoketest/DocsClientYamlTestSuiteIT.java

                new ParseField("compare_analyzers"), CompareAnalyzers::parse));
-        NamedXContentRegistry executeableSectionRegistry = new NamedXContentRegistry(entries);
-        return ESClientYamlSuiteTestCase.createParameters(executeableSectionRegistry);
+        NamedXContentRegistry executableSectionRegistry = new NamedXContentRegistry(entries);


This is now the only file that's a .java -- it's a bit odd that it lives in docs/

Got it, I think it's there because it's the test class that tests the docs snippets. I think it makes sense for it to be there. This way when running ./gradlew :docs:check that one gets run.

jsoref · 2019-01-02T21:43:55Z

@javanna : hopefully this should pass

javanna · 2019-01-03T09:07:09Z

retest this please

javanna · 2019-01-03T12:59:21Z

run gradle build tests 2

javanna · 2019-01-03T15:00:38Z

retest this please

lcawl · 2019-01-03T16:53:33Z

x-pack/docs/en/watcher/release-notes.asciidoc

 * Added <<actions-pagerduty, PagerDuty action>>
 * Added support for adding <<configuring-email-attachments, attachments to emails>>
-  via HTTP requests and superceding and deprecating the usage of `attach_data`
+  via HTTP requests and superseding and deprecating the usage of `attach_data`


I wouldn't consider this one wrong, but otherwise the changes LGTM

javanna · 2019-01-03T19:34:29Z

run gradle build tests 2

javanna · 2019-01-03T19:37:56Z

run gradle build tests 1

javanna · 2019-01-04T09:01:01Z

retest this please

javanna · 2019-01-07T13:45:27Z

thanks a lot @jsoref for all these fixes !!! And even more for making us fix the 5 different ways we were able to misspell the name of our own product :)

jsoref · 2019-01-07T13:57:14Z

Fwiw, that isn't uncommon :-o

jsoref force-pushed the spelling-docs branch 2 times, most recently from 1de0b5d to c2336bb Compare December 31, 2018 15:06

jsoref force-pushed the spelling-docs branch from c2336bb to 2cadc05 Compare December 31, 2018 15:55

jsoref mentioned this pull request Dec 31, 2018

[API] spelling: java script (not JavaScript) #37057

Merged

colings86 added the :Docs label Jan 2, 2019

javanna reviewed Jan 2, 2019

View reviewed changes

docs/java-rest/high-level/watcher/deactivate-watch.asciidoc Outdated

Copy link
Copy Markdown

Contributor

javanna Jan 2, 2019

Choose a reason for hiding this comment

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

@nik9000 another one that we may want to catch

javanna reviewed Jan 2, 2019

View reviewed changes

...org/elasticsearch/xpack/watcher/notification/email/attachment/HttpEmailAttachmentParser.java Outdated Show resolved Hide resolved

javanna reviewed Jan 2, 2019

View reviewed changes

...lasticsearch/xpack/watcher/notification/email/attachment/HttpEmailAttachmentParserTests.java Outdated Show resolved Hide resolved

jsoref force-pushed the spelling-docs branch from 810be4a to fd79612 Compare January 2, 2019 16:06

jsoref added 11 commits January 2, 2019 16:18

spelling: accumulated

2ebbc95

spelling: achieve

b515c87

spelling: across

9635fa5

spelling: actually-an

194e87a

spelling: adjust

e7f18fe

spelling: always

a85fa14

spelling: analyze

7a14357

spelling: availability

d37adb5

spelling: closeables

fbadbef

spelling: common

d6e4b9b

spelling: compatible

2c21d93

jsoref added 5 commits January 2, 2019 16:19

spelling: unusually

8cb2369

spelling: updatable

2797f7b

spelling: using

7358104

spelling: values

566154d

spelling: within

4682545

jsoref force-pushed the spelling-docs branch from fd79612 to 4682545 Compare January 2, 2019 21:24

jsoref commented Jan 2, 2019

View reviewed changes

lcawl reviewed Jan 3, 2019

View reviewed changes

Merge branch 'master' into spelling-docs

eb55d24

javanna added the v7.0.0 label Jan 7, 2019

javanna merged commit edb4832 into elastic:master Jan 7, 2019

javanna added v6.7.0 backport pending labels Jan 7, 2019

javanna pushed a commit that referenced this pull request Jan 7, 2019

[DOCS] Various spelling corrections (#37046)

4e61e95

javanna removed backport pending labels Jan 7, 2019

colings86 added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

danielmitterdorfer added >enhancement >docs General docs changes and removed :Docs labels Feb 8, 2019

Conversation

jsoref commented Dec 31, 2018

Uh oh!

jsoref commented Dec 31, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elasticmachine commented Jan 2, 2019

Uh oh!

javanna Jan 2, 2019

Choose a reason for hiding this comment

Uh oh!

jsoref Jan 2, 2019

Choose a reason for hiding this comment

Uh oh!

javanna Jan 7, 2019

Choose a reason for hiding this comment

Uh oh!

javanna Jan 2, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

javanna commented Jan 2, 2019

Uh oh!

javanna commented Jan 2, 2019

Uh oh!

javanna commented Jan 2, 2019

Uh oh!

jsoref commented Jan 2, 2019

Uh oh!

javanna commented Jan 2, 2019

Uh oh!

javanna commented Jan 2, 2019

Uh oh!

jsoref commented Jan 2, 2019

Uh oh!

jsoref Jan 2, 2019

Choose a reason for hiding this comment

Uh oh!

javanna Jan 3, 2019

Choose a reason for hiding this comment

Uh oh!

jsoref commented Jan 2, 2019

Uh oh!

javanna commented Jan 3, 2019

Uh oh!

javanna commented Jan 3, 2019

Uh oh!

javanna commented Jan 3, 2019

Uh oh!

lcawl Jan 3, 2019

Choose a reason for hiding this comment

Uh oh!

javanna commented Jan 3, 2019

Uh oh!

javanna commented Jan 3, 2019

Uh oh!

javanna commented Jan 4, 2019

Uh oh!

javanna commented Jan 7, 2019

Uh oh!

jsoref commented Jan 7, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

jsoref commented Dec 31, 2018 •

edited

Loading