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

Add ci hook for building API docs (step 2/3) #92827

Merged
merged 1 commit into from
Feb 25, 2021

Conversation

stacey-gammon
Copy link
Contributor

@stacey-gammon stacey-gammon commented Feb 25, 2021

This PR:

  • Sets up ci to run the docs command and check for changes
  • Fixes a bug with absolute import paths not being stripped out which resulted in ci always finding changes
  • Removes some debug lines because there were a ton of them.
  • Pretty prints the JSON

There is one more PR (#92929) that is required to make this work, and it's simply removing api_docs from .gitignore.

Screen Shot 2021-02-25 at 10 47 00 AM

If you want to view these docs rendered

  1. Clone the elastic-docs repo
  2. Edit config/sourced-dev.json and add:
    {
      "type": "file",
      "location": "../kibana/api_docs"
    },

Assuming your kibana is a sibling to the elastic-docs repo and the folder is called kibana.

  1. Merge https://github.com/elastic/elastic-docs/pull/260 to have the nav items show up.

  2. In your kibana repo, pull down this PR, or, just run node scripts/build_api_docs.

  3. Run yarn start in the elastic-docs repo

  4. Navigate to localhost:8000 and the Kibana Developer Docs Mission.

@stacey-gammon stacey-gammon force-pushed the 2021-02-25-api-docs-ci branch 4 times, most recently from a8c0b32 to c5e03df Compare February 25, 2021 20:39
@stacey-gammon stacey-gammon changed the title API DOCS!! 🎉 Add ci hook for building API docs (step 2/3) Feb 25, 2021
@stacey-gammon stacey-gammon added v7.13.0 v8.0.0 release_note:skip Skip the PR/issue when compiling release notes auto-backport Deprecated - use backport:version if exact versions are needed labels Feb 25, 2021
@stacey-gammon stacey-gammon requested a review from kobelb February 25, 2021 21:47
@stacey-gammon stacey-gammon mentioned this pull request Feb 25, 2021
4 tasks
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

  • 💔 Build #109577 failed a8c0b32d4b9d14e27ba42de23a58fa20d08446ef
  • 💔 Build #109489 failed c74b5402556bddbdd647b34f8ccbcb854eb40bef
  • 💔 Build #109456 failed 540248b16b08fadb6e99f07aaecb3c3ad5eb70dd
  • 💔 Build #109439 failed 7957e1983bbbdbd12d0c5d4659e47493bc70c165
  • 💔 Build #109422 failed a67a5da034325cdd5ae53e2da4730f81fd827438

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

@stacey-gammon stacey-gammon marked this pull request as ready for review February 25, 2021 22:51
@stacey-gammon stacey-gammon requested a review from a team as a code owner February 25, 2021 22:55
@stacey-gammon stacey-gammon merged commit 3df61f7 into elastic:master Feb 25, 2021
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Feb 25, 2021
@kibanamachine
Copy link
Contributor

💚 Backport successful

7.x / #92940

Successful backport PRs will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request Feb 26, 2021
Co-authored-by: Stacey Gammon <gammon@elastic.co>
gmmorris added a commit to gmmorris/kibana that referenced this pull request Feb 26, 2021
…bana into task-manager/docs-monitoring

* 'task-manager/docs-monitoring' of github.com:gmmorris/kibana: (40 commits)
  [Security Solution][Case][Bug] Improve case logging (elastic#91924)
  [Alerts][Doc] Added README documentation for alerts plugin status and framework health checks configuration options. (elastic#92761)
  Add warning for EQL and Threshold rules if exception list contains value list items (elastic#92914)
  [Security Solution][Case] Fix subcases bugs on detections and case view (elastic#91836)
  [APM] Always allow access to Profiling via URL (elastic#92889)
  [Vega] Allow image loading without CORS policy by changing the default to crossOrigin=null (elastic#91991)
  skip flaky suite (elastic#92114)
  [APM] Fix for default fields in correlations view (elastic#91868) (elastic#92090)
  chore(NA): bump bazelisk to v1.7.5 (elastic#92905)
  [Maps] fix selecting EMS basemap does not populate input (elastic#92711)
  API docs (elastic#92827)
  [kbn/test] add import/export support to KbnClient (elastic#92526)
  Test fix management scripted field filter functional test and unskip it  (elastic#92756)
  [App Search] Create Curation view/functionality (elastic#92560)
  [Reporting/Discover] include the document's entire set of fields (elastic#92730)
  [Fleet] Add new index to fleet for artifacts being served out of fleet-server (elastic#92860)
  [Alerts][Doc] Added README documentation for API key invalidation configuration options. (elastic#92757)
  [Discover][docs] Add search for relevance (elastic#90611)
  [Alerts][Docs] Extended README.md and the user docs with the licensing information. (elastic#92564)
  [7.12][Telemetry] Security telemetry allowlist fix. (elastic#92850)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes v7.13.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants