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

feat: looker resources index #931

Merged
merged 7 commits into from
Dec 28, 2021
Merged

Conversation

fabio-looker
Copy link
Contributor

This PR adds the "Looker resources index"

As its readme explains, this folder contains data (in code) about Looker-related resources, and scripts to maintain and repackage that data for publication.

The resource data is based off of (and enhanced from) the data in https://github.com/looker-open-source/sdk-codegen/blob/main/packages/hackathon/src/scenes/ResourceScene/resource_data.ts

However, this change now decouples the data from the hackathon app (e.g. so it can also be used in the developer portal), and allows it to be published to a web CDN as JSON, rather than only imported as a TS dependency.

@fabio-looker fabio-looker changed the title Fabble/looker resources index feat: looker resources index Dec 21, 2021
Copy link
Contributor

@jkaster jkaster left a comment

Choose a reason for hiding this comment

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

Minor items

bin/looker-resources-index/README.md Outdated Show resolved Hide resolved
bin/looker-resources-index/package.json Show resolved Hide resolved
jkaster
jkaster previously approved these changes Dec 23, 2021
Copy link
Contributor

@jkaster jkaster left a comment

Choose a reason for hiding this comment

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

Looks good!


The main location that the data is maintained is in `src/resource-data/resources.ts`

The main output of these scripts is a JSON file in `../../docs/resources` intended to be checked in to git and consumed via CDN. (However, you could conceivably also consume the typescript exports from this folder)
Copy link
Collaborator

Choose a reason for hiding this comment

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

(However, you could conceivably also consume the typescript exports from this folder) -> If you need the types and LocaleStrings, you need to import the typescript exports from this folder, bin/looker-resources-index

jeremytchang
jeremytchang previously approved these changes Dec 23, 2021
Copy link
Collaborator

@jeremytchang jeremytchang left a comment

Choose a reason for hiding this comment

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

LGTM outside of minor Readme change. Good stuff, dig the analyze and build functionality and the additional fields like language. Thanks for making the resources listing much more robust and detailed. :D
I'll setup a few tasks to: 1) Add json to CDN 2) Integrate into hackathon 3) Integrate into devportal.

@jeremytchang
Copy link
Collaborator

Also will add one more task for CI to auto build json on merge.

@fabio-looker
Copy link
Contributor Author

@jeremytchang Updated the line in the readme that you commented on, so I need to request a re-approval! Thanks 😄

Copy link
Collaborator

@jeremytchang jeremytchang left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@fabio-looker fabio-looker merged commit 82e965b into main Dec 28, 2021
@fabio-looker fabio-looker deleted the fabble/looker-resources-index branch December 28, 2021 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants