github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 10:40:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

[docs-utils] remove extra api_docs dir (#148658)

Browse source 
In order to avoid searching the `api_docs` directory at the root of the
repo in VSCode we have to exclude all api_docs dirs from search, so
instead of putting the source of the code that generates the api_docs in
a similarly named dir this just removes that wrapper.
This commit is contained in:
Spencer 2023-01-10 13:20:35 -06:00 • committed by GitHub
parent d2cb4bb4f7
commit 52d235ae49
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
72 changed files with 151 additions and 150 deletions
Download patch file Download diff file Expand all files Collapse all files

2
dev_docs/contributing/documentation.mdx
View file

@ -171,7 +171,7 @@ There are three great ways to debug issues with the API infrastructure.
1. Write a test
[api_doc_suite.test.ts](https://github.com/elastic/kibana/blob/main/packages/kbn-docs-utils/src/api_docs/tests/api_doc_suite.test.ts) is a pretty comprehensive test suite that builds the test docs inside the [**fixtures** folder](https://github.com/elastic/kibana/tree/main/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src).
[api_doc_suite.test.ts](https://github.com/elastic/kibana/blob/main/packages/kbn-docs-utils/src/tests/api_doc_suite.test.ts) is a pretty comprehensive test suite that builds the test docs inside the [**fixtures** folder](https://github.com/elastic/kibana/tree/main/packages/kbn-docs-utils/src/tests/__fixtures__/src).
Edit the code inside `__fixtures__` to replicate the bug, write a test to track what should happen, then run `yarn jest api_doc_suite`.