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 documentation for sources #187

Merged
merged 1 commit into from
Apr 19, 2024
Merged

Add documentation for sources #187

merged 1 commit into from
Apr 19, 2024

Conversation

cpuguy83
Copy link
Member

No description provided.

Copy link
Contributor

@DannyBrito DannyBrito left a comment

Choose a reason for hiding this comment

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

Maybe we could also point some of the fixture templates in the examples if relevant/applicable.

docs/sources.md Outdated Show resolved Hide resolved
docs/sources.md Outdated Show resolved Hide resolved
docs/sources.md Outdated Show resolved Hide resolved
docs/sources.md Outdated Show resolved Hide resolved
docs/sources.md Outdated Show resolved Hide resolved
docs/sources.md Outdated Show resolved Hide resolved
@cpuguy83 cpuguy83 force-pushed the source_docs branch 2 times, most recently from 04ac291 to 8d98fd8 Compare April 16, 2024 15:15
@cpuguy83
Copy link
Member Author

Maybe we could also point some of the fixture templates in the examples if relevant/applicable.

Do you mean anchors?
We could maybe add an example, but I'm not too keen on keeping yaml-specific docs here.

website/docs/intro.md Outdated Show resolved Hide resolved
@sozercan
Copy link
Member

@cpuguy83
Copy link
Member Author

Added to sidebar

Copy link
Member

@sozercan sozercan left a comment

Choose a reason for hiding this comment

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

LGTM

@cpuguy83
Copy link
Member Author

Maybe we could also point some of the fixture templates in the examples if relevant/applicable.

Do you mean anchors? We could maybe add an example, but I'm not too keen on keeping yaml-specific docs here.

@DannyBrito I was thinking we could add a tips/tricks section in the docs for more advanced use cases. WDYT?

website/docs/sources.md Outdated Show resolved Hide resolved
website/docs/sources.md Outdated Show resolved Hide resolved
website/docs/sources.md Outdated Show resolved Hide resolved
website/docs/sources.md Outdated Show resolved Hide resolved
@DannyBrito
Copy link
Contributor

Maybe we could also point some of the fixture templates in the examples if relevant/applicable.

Do you mean anchors? We could maybe add an example, but I'm not too keen on keeping yaml-specific docs here.

No, I actually was referring to point out when applicable to the tests specs that live under test/fixtures example: local-context.yml. Because sometimes these could be used as part and/or more examples, when we are talking about a specific source type or specific field option in these sources.

Maybe we could also point some of the fixture templates in the examples if relevant/applicable.

Do you mean anchors? We could maybe add an example, but I'm not too keen on keeping yaml-specific docs here.

@DannyBrito I was thinking we could add a tips/tricks section in the docs for more advanced use cases. WDYT?

Yeah that sounds good, more examples and advance use cases are always good 😄

@cpuguy83
Copy link
Member Author

@DannyBrito I've added a section linking to the test fixtures (with some warnings on usage).

Copy link
Contributor

@DannyBrito DannyBrito left a comment

Choose a reason for hiding this comment

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

lgtm

@cpuguy83 cpuguy83 merged commit c363b50 into Azure:main Apr 19, 2024
5 checks passed
@cpuguy83 cpuguy83 deleted the source_docs branch April 19, 2024 21:10
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