chore: Move chef-cli docs to fern #186

tilenkavcic · 2025-03-29T17:01:08Z

This brings in documentation from the chef-cli repository. This first version improves metadata extraction and adds IDM.
There is also a framework do add the rest under the Data model folder, but this is hidden for now.

https://app.devrev.ai/devrev/works/ISS-154217

github-actions · 2025-03-29T17:02:08Z

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email support@ekline.io.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

EkLine

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/getting-started.mdx

Line 8 in 7b9dc82

- [jq](https://stedolan.github.io/jq)

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/getting-started.mdx

Line 9 in 7b9dc82

- [golang](https://go.dev/doc/install)

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/getting-started.mdx

Line 10 in 7b9dc82

    
           - [nodejs](https://nodejs.org/en/download/package-manager) (version 18.x.x+ or higher)

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/getting-started.mdx

Line 22 in 7b9dc82

1. Create an import at **Settings** > **Imports** > **Import**.

github-actions · 2025-03-29T17:02:31Z

Published docs preview URL: https://devrev-preview-90c66bf2-3f81-41d0-a259-f7836e0d67c5.docs.buildwithfern.com

fern/docs/pages/airdrop/getting-started.mdx

github-actions · 2025-03-29T18:34:03Z

Published docs preview URL: https://devrev-preview-5398c69b-dd6c-4859-82f0-e6dfda8ec59a.docs.buildwithfern.com

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

EkLine

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/airdrop/initial-domain-mapping.mdx

Line 92 in 6b87ad4

    
           This mapping, unlike the recipe blueprint of a concrete import, can contain multiple options for each external record type from which the end-user might choose (for example allow *task* from an external system to map either to *issue* or *ticket* in DevRev), and it can contain also mappings that apply to a record type category. When the user runs a new import, and the extractor reports in its metadata record types belonging to this category, that are not directly mapped in the initial domain mappings, the recipe manager will apply the per-category default to them.

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/initial-domain-mapping.mdx

Line 103 in 6b87ad4

    
           - raw jq transformations using an external field as input. (This is an experimental feature)

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 19 in 6b87ad4

This will output any problems there may be with the metadata file.

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 53 in 6b87ad4

- Contain the same type of records, named after their type

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 54 in 6b87ad4

- Have .json or .jsonl extension, for example `issues.json`

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 55 in 6b87ad4

- Contain either a single JSON array of objects, or newline-separated objects

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 57 in 6b87ad4

2. Run the `infer-metadata` command targeting this directory

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 59 in 6b87ad4

    
           3. Inspect the generated metadata, particularly field types and the suggestions the tool generates

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 62 in 6b87ad4

- Provide 10-100 examples of each record type (but not more than 1000)

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 63 in 6b87ad4

- Ensure logically distinct fields are separate keys at the top level

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 64 in 6b87ad4

- Use referentially consistent example data if possible

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 65 in 6b87ad4

- Make sure IDs are strings, not numbers

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 67 in 6b87ad4

    
           This generated metadata serves as a starting point that will need further refinement. It can be used to prototype initial domain mappings (by running a sync with it) and to generate example normalized data, but it is still just a guess: It has to be reviewed and refined.

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 348 in 6b87ad4

    
           `is_write_only` etc. By default these will be set to false. You can find the full list of supported

🚫 [EkLine] _{reported by reviewdog 🐶}

Prefer English terms over Latin abbreviations. Use 'for example' instead of 'e.g.'. (EK00026)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 354 in 6b87ad4

    
           possible (e.g., to move to the 'resolved' status, an issue first has to be 'in_testing'), you

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 357 in 6b87ad4

    
           This will allow creation of a matching 'stage diagram' (a collection of stages and their permitted

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 436 in 6b87ad4

- The status field is the controlling field of the stage diagram

🚫 [EkLine] _{reported by reviewdog 🐶}

Suggestions:

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 437 in 6b87ad4

    
           - If a status field has no explicit transitions but you still want a stage diagram, set `all_transitions_allowed` to `true`, which will create a diagram where all the defined stages can transition to each other

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 438 in 6b87ad4

    
           - External systems may categorize statuses (like Jira's status categories), which can be included in the diagram metadata (`states` in the example)

⚠️ [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 439 in 6b87ad4

    
           - The `starting_stage` defines the initial stage for new object instances. This data should always be provided if available, otherwise the starting stage will be selected alphabetically

🚫 [EkLine] _{reported by reviewdog 🐶}

Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 440 in 6b87ad4

    
           - In current metadata format (v0.2.0), the order and human-readable name are taken from the enum values defined on the controlling field

🚫 [EkLine] _{reported by reviewdog 🐶}

Suggestions:

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
Must put the ending punctuation at the end of a list item. (EK00041)

fern-api-docs/fern/docs/pages/airdrop/metadata-extraction.mdx

Line 441 in 6b87ad4

    
           - If the `states` field is not provided, default DevRev states will be used: `open`, `in_progress` and `closed`

github-actions · 2025-03-29T20:15:30Z

Published docs preview URL: https://devrev-preview-975f1dc4-ce55-47c2-b105-1b097a94570e.docs.buildwithfern.com

github-actions · 2025-03-29T20:21:39Z

Published docs preview URL: https://devrev-preview-bff63461-6108-4a4c-9b68-e2db9b1e5b62.docs.buildwithfern.com

github-actions · 2025-03-29T20:30:00Z

Published docs preview URL: https://devrev-preview-0d3ee3c4-fb65-4072-a607-411e58922de3.docs.buildwithfern.com

github-actions · 2025-03-29T20:46:39Z

Published docs preview URL: https://devrev-preview-a7a8d656-e518-4ae3-9d17-af2d1167d0c3.docs.buildwithfern.com

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

github-actions · 2025-03-29T20:57:07Z

Published docs preview URL: https://devrev-preview-8bcb901b-5486-453d-810a-a900408c4d5f.docs.buildwithfern.com

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

github-actions · 2025-03-30T16:41:52Z

Published docs preview URL: https://devrev-preview-7b1f8b81-3cac-448c-b9cc-c52d7dfddc63.docs.buildwithfern.com

github-actions · 2025-03-30T17:04:07Z

Published docs preview URL: https://devrev-preview-1334cc5a-bda7-4ea6-bf53-9a51effd9e6c.docs.buildwithfern.com

github-actions · 2025-03-30T18:15:40Z

Published docs preview URL: https://devrev-preview-d1ed6ee4-b31e-4e11-b8a8-110e4aa775c4.docs.buildwithfern.com

github-actions · 2025-03-30T18:50:14Z

Published docs preview URL: https://devrev-preview-40009eea-fe92-4617-96ab-98585f0cad25.docs.buildwithfern.com

github-actions · 2025-03-31T07:00:28Z

Published docs preview URL: https://devrev-preview-68f1fc37-f674-4437-8c67-d0aab45c0cee.docs.buildwithfern.com

erazemk

There are so many changes I didn't manage to read them all, but the overall gist looks fine

fern/docs/pages/airdrop/data-extraction.mdx

fern/docs/pages/airdrop/data-model/mapping_reasons.mdx

fern/docs/pages/airdrop/data-model/permissions.mdx

github-actions · 2025-03-31T12:09:21Z

Published docs preview URL: https://devrev-preview-9f8a000c-8410-4bce-beef-3603fa04cf70.docs.buildwithfern.com

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

github-actions · 2025-03-31T12:13:07Z

Published docs preview URL: https://devrev-preview-aee0297b-fcb5-4ed9-963b-fe742392abd2.docs.buildwithfern.com

fern/docs/pages/airdrop/getting-started.mdx

github-actions · 2025-03-31T12:13:50Z

Published docs preview URL: https://devrev-preview-582349fa-8585-4169-86cc-4815b83145a7.docs.buildwithfern.com

bc-devrev

Approved with some suggestions.

fern/docs/pages/airdrop/data-model/permissions.mdx

fern/docs/pages/airdrop/data-model/rich-text.mdx

fern/docs/pages/airdrop/initial-domain-mapping.mdx

fern/docs/pages/airdrop/faq.mdx

fern/docs/pages/airdrop/data-model/mapping_reasons.mdx

github-actions · 2025-04-01T07:13:40Z

Published docs preview URL: https://devrev-preview-5c9bbd1d-759a-4a75-97c2-7709587befbe.docs.buildwithfern.com

fern/docs/pages/airdrop/initial-domain-mapping.mdx

github-actions · 2025-04-01T07:40:59Z

Published docs preview URL: https://devrev-preview-343ec41a-0c18-4ebb-88d5-846677942390.docs.buildwithfern.com

tilenkavcic added 2 commits March 29, 2025 17:48

Fix bash code

314e918

Make diagram look better

7b9dc82

github-actions bot reviewed Mar 29, 2025

View reviewed changes

tilenkavcic added 3 commits March 29, 2025 18:38

Adjust colors

6364bd4

Merge step-by-step with existing

7472f76

Add missing things to metadata extraction

cd659e9

github-actions bot reviewed Mar 29, 2025

View reviewed changes

fern/docs/pages/airdrop/getting-started.mdx Show resolved Hide resolved

github-actions bot reviewed Mar 29, 2025

View reviewed changes

fern/docs/pages/airdrop/getting-started.mdx Show resolved Hide resolved

github-actions bot reviewed Mar 29, 2025

View reviewed changes

fern/docs/pages/airdrop/getting-started.mdx Show resolved Hide resolved

tilenkavcic added 4 commits March 29, 2025 19:45

Add schema and validation info

8db455d

Make faq accordion group

4d4331a

Improve metadata extraction

03e97fd

Add IDM and the rest from chef

6b87ad4

github-actions bot reviewed Mar 29, 2025

View reviewed changes

tilenkavcic changed the title ~~chore: Move Chef cli docs to fern~~ chore: Move chef-cli docs to fern Mar 29, 2025

Fix path

0f4f7fa

Revert diagram change

0e035dd

Update faq

5c63e01

tilenkavcic added 2 commits March 29, 2025 21:34

Proofread IDM

f1066ea

Proofread fax and metadata extraction

b8dd7b5

Apply suggestions from code review

0a4c788

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Apply suggestions from EkLine

3c1705a

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Add code highlight

7ba56de

tilenkavcic marked this pull request as ready for review March 30, 2025 17:05

tilenkavcic requested a review from a team as a code owner March 30, 2025 17:05

tilenkavcic requested review from radovanjorgic and erazemk March 30, 2025 17:06

Small visual change

5300b32

Refine rich text docs

9496ebd

Don't use ellipsis

91bae49

erazemk reviewed Mar 31, 2025

View reviewed changes

Address comments

5520847

tilenkavcic and others added 2 commits March 31, 2025 14:11

Fix getting started overview

178d6ae

Apply EkLine suggestions

4ff66d9

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

github-actions bot reviewed Mar 31, 2025

View reviewed changes

fern/docs/pages/airdrop/getting-started.mdx Show resolved Hide resolved

tilenkavcic requested a review from erazemk March 31, 2025 13:02

bc-devrev approved these changes Mar 31, 2025

View reviewed changes

Address comments

f3ffd4e

Adjust code indent, address comments

0b97d10

github-actions bot reviewed Apr 1, 2025

View reviewed changes

fern/docs/pages/airdrop/initial-domain-mapping.mdx Show resolved Hide resolved

fern/docs/pages/airdrop/initial-domain-mapping.mdx Show resolved Hide resolved

tilenkavcic merged commit a9bc3c9 into main Apr 1, 2025
3 checks passed

tilenkavcic deleted the tilenk/chef-cli branch April 1, 2025 07:44

chore: Move chef-cli docs to fern #186

chore: Move chef-cli docs to fern #186

Uh oh!

Conversation

tilenkavcic commented Mar 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌟 EkLine Reviewer

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 29, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 29, 2025

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 29, 2025

Uh oh!

github-actions bot commented Mar 29, 2025

Uh oh!

github-actions bot commented Mar 29, 2025

Uh oh!

github-actions bot commented Mar 29, 2025

Uh oh!

github-actions bot commented Mar 29, 2025

Uh oh!

github-actions bot commented Mar 30, 2025

Uh oh!

github-actions bot commented Mar 30, 2025

Uh oh!

github-actions bot commented Mar 30, 2025

Uh oh!

github-actions bot commented Mar 30, 2025

Uh oh!

github-actions bot commented Mar 31, 2025

Uh oh!

erazemk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 31, 2025

Uh oh!

github-actions bot commented Mar 31, 2025

Uh oh!

Uh oh!

github-actions bot commented Mar 31, 2025

Uh oh!

bc-devrev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 1, 2025

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 1, 2025

Uh oh!

Uh oh!

tilenkavcic commented Mar 29, 2025 •

edited

Loading

github-actions bot commented Mar 29, 2025 •

edited

Loading