Skip to content

chore: Move chef-cli docs to fern #186

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

Merged
merged 28 commits into from
Apr 1, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
314e918
Fix bash code
tilenkavcic Mar 29, 2025
7b9dc82
Make diagram look better
tilenkavcic Mar 29, 2025
6364bd4
Adjust colors
tilenkavcic Mar 29, 2025
7472f76
Merge step-by-step with existing
tilenkavcic Mar 29, 2025
cd659e9
Add missing things to metadata extraction
tilenkavcic Mar 29, 2025
8db455d
Add schema and validation info
tilenkavcic Mar 29, 2025
4d4331a
Make faq accordion group
tilenkavcic Mar 29, 2025
03e97fd
Improve metadata extraction
tilenkavcic Mar 29, 2025
6b87ad4
Add IDM and the rest from chef
tilenkavcic Mar 29, 2025
0f4f7fa
Fix path
tilenkavcic Mar 29, 2025
0e035dd
Revert diagram change
tilenkavcic Mar 29, 2025
5c63e01
Update faq
tilenkavcic Mar 29, 2025
f1066ea
Proofread IDM
tilenkavcic Mar 29, 2025
b8dd7b5
Proofread fax and metadata extraction
tilenkavcic Mar 29, 2025
0a4c788
Apply suggestions from code review
tilenkavcic Mar 29, 2025
3c1705a
Apply suggestions from EkLine
tilenkavcic Mar 29, 2025
5280d82
Fix wrapping
tilenkavcic Mar 29, 2025
4880a26
Fix title
tilenkavcic Mar 30, 2025
bdf4944
Refine styling
tilenkavcic Mar 30, 2025
7ba56de
Add code highlight
tilenkavcic Mar 30, 2025
5300b32
Small visual change
tilenkavcic Mar 30, 2025
9496ebd
Refine rich text docs
tilenkavcic Mar 30, 2025
91bae49
Don't use ellipsis
tilenkavcic Mar 31, 2025
5520847
Address comments
tilenkavcic Mar 31, 2025
178d6ae
Fix getting started overview
tilenkavcic Mar 31, 2025
4ff66d9
Apply EkLine suggestions
tilenkavcic Mar 31, 2025
f3ffd4e
Address comments
tilenkavcic Apr 1, 2025
0b97d10
Adjust code indent, address comments
tilenkavcic Apr 1, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion fern/docs/pages/airdrop/data-extraction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,5 +78,5 @@ All other fields are contained within the `data` attribute.
Extracted artifacts can be validated with the `chef-cli` using the following command:

```bash
$ chef-cli validate-metadata -m external_domain_metadata.json -r issue < extractor_issues_2.json
chef-cli validate-metadata -m external_domain_metadata.json -r issue < extractor_issues_2.json
```
19 changes: 17 additions & 2 deletions fern/docs/pages/airdrop/extraction-phases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ sequenceDiagram
'theme': 'base',
'themeVariables': {
'fontFamily': 'Segoe UI',
'primaryColor': '#4285F4',
'primaryTextColor': '#fff',
'primaryBorderColor': '#7570b3',
'lineColor': '#555',
'secondaryColor': '#f8f8f8',
'tertiaryColor': '#f4f4f4',
'signalColor': '#7d7f7c',
'signalTextColor': '#7d7f7c'
}}}%%
Expand All @@ -21,36 +27,44 @@ sequenceDiagram
participant ad as Airdrop components
participant ee as External extractor

note over gw,ad: Extract External Sync Units
rect rgb(240, 245, 255)
note over gw,ad: Extract External Sync Units
user ->> gw: Select import connection
gw ->> ad: Start External Sync Unit extraction
ad ->> ee: Start External Sync Unit extraction
ee -->> gw: List of External Sync Units
gw ->> ad: List of External Sync Units
ad ->> gw: List of External Sync Units
gw -->> user: Show available External Sync Units
end


rect rgb(240, 248, 240)
note over gw,ad: Extract Metadata
ad ->> ee: Start Metadata extraction
ee -->> gw: List of extracted metadata artifacts
gw ->> ad: List of extracted metadata artifacts
end

rect rgb(245, 245, 245)
note over gw,ad: Extract data
ad ->> ee: Start data extraction
ee -->> gw: List of extracted data artifacts
gw ->> ad: List of extracted data artifacts

note over ad: Transform and import data into DevRev
end

rect rgb(255, 246, 240)
note over gw,ad: Extract attachments
ad ->> ee: Start attachment extraction
ee -->> gw: List of extracted attachments
gw ->> ad: List of extracted attachments

ad -->> gw: Finished import
gw -->> user: Show finished import and report
end

rect rgb(248, 240, 245)
note over gw,ad: Delete data
user ->> gw: Delete import
gw ->> ad: Delete import
Expand All @@ -65,6 +79,7 @@ sequenceDiagram
note over ad: Deletes internal data
ad -->> gw: Finished deleting import
gw -->> user: Import deleted
end
```

## Sync modes
Expand Down
4 changes: 2 additions & 2 deletions fern/docs/pages/airdrop/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ Select _Use this template_ and then _Create a new repository_.
## Observability

- To observe logs from your snap-in in your development environment:
```
```bash
devrev snap_in_package logs | jq
```
- To open logs in your favorite editor:
```
```bash
devrev snap_in_package logs | code -
```

Expand Down
Loading