Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Fixes links in Developer docs #81843

Merged
merged 8 commits into from
Nov 9, 2020

Conversation

KOTungseth
Copy link
Contributor

@KOTungseth KOTungseth commented Oct 27, 2020

Summary

Fixes the links in the Developer docs.

@KOTungseth KOTungseth added Team:Docs release_note:skip Skip the PR/issue when compiling release notes v7.10.0 v7.9.0 v7.11.0 labels Oct 27, 2020
@KOTungseth KOTungseth self-assigned this Oct 27, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

Copy link
Contributor

@stacey-gammon stacey-gammon left a comment

Choose a reason for hiding this comment

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

cc @tylersmalley - can someone from ops help @KOTungseth out with fixing the broken links?

Co-authored-by: Stacey Gammon <gammon@elastic.co>
@KOTungseth KOTungseth added the Team:Operations Team label for Operations Team label Oct 28, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-operations (Team:Operations)

@KOTungseth KOTungseth requested a review from a team October 28, 2020 15:02
@spalger
Copy link
Contributor

spalger commented Oct 28, 2020

@elasticmachine run elasticsearch-ci/docs

Copy link
Contributor

@spalger spalger left a comment

Choose a reason for hiding this comment

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

LGTM, though the link: tag/prefix seems unnecessary and inconsistent.

@tylersmalley
Copy link
Contributor

Preview for anyone else wanting to take a look: https://kibana_81843.docs-preview.app.elstc.co/guide/en/kibana/7.10/development-tests.html

Copy link
Contributor

@tylersmalley tylersmalley left a comment

Choose a reason for hiding this comment

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

LGTM, just a small nitpick to remove double slashes in the URL's.

@stacey-gammon
Copy link
Contributor

I think the original links are still broken (at least I checked one and it was). I think @KOTungseth needs help figuring out what links to use to replace the broken ones with she listed in the main issue. :)

@jbudz
Copy link
Member

jbudz commented Oct 29, 2020

Regarding the top comment for currently broken paths,

diff --git a/docs/developer/contributing/development-functional-tests.asciidoc b/docs/developer/contributing/development-functional-tests.asciidoc
index 368af041c51..6ef7c3d9513 100644
--- a/docs/developer/contributing/development-functional-tests.asciidoc
+++ b/docs/developer/contributing/development-functional-tests.asciidoc
@@ -289,8 +289,8 @@ Within a test Provider the API is exactly the same as the service providers API
 The `FunctionalTestRunner` comes with three built-in services:
 
 **config:**:::
-* Source: {kib-repo}/tree/{branch}/src/functional_test_runner/lib/config/config.ts[src/functional_test_runner/lib/config/config.ts]
-* Schema: {kib-repo}/tree/{branch}/src/functional_test_runner/lib/config/schema.ts[src/functional_test_runner/lib/config/schema.ts]
+* Source: {kib-repo}/tree/{branch}/packages/kbn-test/src/functional_test_runner/lib/config/config.ts[packages/kbn-test/src/functional_test_runner/lib/config/config.ts]
+* Schema: {kib-repo}/tree/branch}/packages/kbn-test/src/functional_test_runner/lib/config/schema.ts[packages/kbn-test/src/functional_test_runner/lib/config/schema.ts]
 * Use `config.get(path)` to read any value from the config file
 
 **log:**:::
@@ -299,7 +299,7 @@ The `FunctionalTestRunner` comes with three built-in services:
 * `log.verbose()`, `log.debug()`, `log.info()`, `log.warning()` all work just like console.log but produce more organized output
 
 **lifecycle:**:::
-* Source: {kib-repo}/tree/{branch}/src/functional_test_runner/lib/lifecycle.ts[src/functional_test_runner/lib/lifecycle.ts]
+* Source: {kib-repo}/tree/{branch}/packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts[packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts]
 * Designed primary for use in services
 * Exposes lifecycle events for basic coordination. Handlers can return a promise and resolve/fail asynchronously
 * Phases include: `beforeLoadTests`, `beforeTests`, `beforeEachTest`, `cleanup`
@@ -310,14 +310,14 @@ The `FunctionalTestRunner` comes with three built-in services:
 The {kib} functional tests define the vast majority of the actual functionality used by tests.
 
 **browser**:::
-* Source: link:{kib-repo}/tree/{branch}/test/functional/services/browser.ts[test/functional/services/browser.ts]
+* Source: {kib-repo}/tree/{branch}/test/functional/services/common/browser.ts[test/functional/services/common/browser.ts]
 * Higher level wrapper for `remote` service, which exposes available browser actions
 * Popular methods:
 ** `browser.getWindowSize()`
 ** `browser.refresh()`
 
 **testSubjects:**:::
-* Source: {kib-repo}/tree/{branch}/test/functional/services/test_subjects.ts[test/functional/services/test_subjects.ts]
+* Source: {kib-repo}/tree/{branch}/test/functional/services/common/test_subjects.ts[test/functional/services/common/test_subjects.ts]
 * Test subjects are elements that are tagged specifically for selecting from tests
 * Use `testSubjects` over CSS selectors when possible
 * Usage:
@@ -342,7 +342,7 @@ await testSubjects.click(‘containerButton’);
 ** `testSubjects.click(testSubjectSelector)` - Click a test subject in the page; throw if it can't be found after some time
 
 **find:**:::
-* Source: {kib-repo}/tree/{branch}/test/functional/services/find.ts[test/functional/services/find.ts]
+* Source: {kib-repo}/tree/{branch}/test/functional/services/common/find.ts[test/functional/services/common/find.ts]
 * Helpers for `remote.findBy*` methods that log and manage timeouts
 * Popular methods:
 ** `find.byCssSelector()`
diff --git a/docs/developer/plugin/external-plugin-functional-tests.asciidoc b/docs/developer/plugin/external-plugin-functional-tests.asciidoc
index b39d576d852..5bd75f1b8a7 100644
--- a/docs/developer/plugin/external-plugin-functional-tests.asciidoc
+++ b/docs/developer/plugin/external-plugin-functional-tests.asciidoc
@@ -69,7 +69,7 @@ export default async function ({ readConfigFile }) {
     }
 
     // more settings, like timeouts, mochaOpts, etc are
-    // defined in the config schema. See {blob}src/functional_test_runner/lib/config/schema.js[src/functional_test_runner/lib/config/schema.js]
+    // defined in the config schema. See {blob}packages/kbn-test/functional_test_runner/lib/config/schema.js[packages/kbn-test/functional_test_runner/lib/config/schema.js]
   };
 }

The patch may be slightly off, I manually wrote the changes in:

ftr paths: src/functional_test_runner -> packages/kbn-test
helper util paths: nested under a new common folder

@KOTungseth
Copy link
Contributor Author

@elasticmachine merge upstream

@KOTungseth KOTungseth merged commit f7175bb into elastic:7.10 Nov 9, 2020
@KOTungseth KOTungseth deleted the docs/dev-links branch November 9, 2020 21:51
KOTungseth added a commit that referenced this pull request Nov 9, 2020
* [DOCS] Fixed links in Developer docs

* Update docs/developer/contributing/development-functional-tests.asciidoc

Co-authored-by: Stacey Gammon <gammon@elastic.co>

* Update docs/developer/contributing/development-functional-tests.asciidoc

Co-authored-by: Tyler Smalley <tylersmalley@me.com>

* Fixes ftr links

* Fixes to remaining links

Co-authored-by: Stacey Gammon <gammon@elastic.co>
Co-authored-by: Tyler Smalley <tylersmalley@me.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs Team:Operations Team label for Operations Team v7.9.0 v7.10.0 v7.11.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants