Skip to content
This repository has been archived by the owner on Oct 29, 2024. It is now read-only.

feat(compogen): add extra section with --extraContents flag' #171

Merged
merged 9 commits into from
Jun 24, 2024

Conversation

jvallesm
Copy link
Collaborator

@jvallesm jvallesm commented Jun 21, 2024

Because

  • Sometimes we want to extend auto-generated docs with custom content.
    • This is particularly true until JSON schema can be properly parsed by compogen, which will add more detail to the complex input / output params.

This commit

  • Adds conent-injection capabilities to compogen.

ℹ️ Info

  • You'll notice extra newlines added everywhere. I had avoided this at the cost of a less readable template. But it is ok to have ugly auto-generated code (as long as the rendered Markdown / HTML isn't affected). What we want to read clearly is the source template and the rendered documentation.
  • Therefore, review is easier on a commit-by-commit basis 😇

Example

#172 exemplifies how to add extra sections in the Text operator.

@jvallesm jvallesm self-assigned this Jun 21, 2024
@jvallesm jvallesm marked this pull request as ready for review June 21, 2024 17:40
@jvallesm jvallesm force-pushed the jvalles/compogen-inject-section branch from 0122dab to 4f74266 Compare June 24, 2024 06:03
@jvallesm jvallesm merged commit 391bb98 into main Jun 24, 2024
9 checks passed
@jvallesm jvallesm deleted the jvalles/compogen-inject-section branch June 24, 2024 08:13
namwoam pushed a commit to namwoam/component that referenced this pull request Jun 24, 2024
…-ai#171)

Because

- Sometimes we want to extend auto-generated docs with custom content.
- This is particularly true until JSON schema can be properly parsed by
`compogen`, which will add more detail to the complex input / output
params.

This commit

- Adds conent-injection capabilities to compogen.

### ℹ️ Info

- You'll notice extra newlines added
[everywhere](https://github.com/instill-ai/component/pull/171/files#diff-4b320521a406c97d7c1ccad3dbda779ea82206f7fdba3a7fe69c29d9834f81d0R21).
I had avoided this at the cost of a less readable
[template](https://github.com/instill-ai/component/pull/171/files#diff-3ddf390734accc49bc9993e2358b740523d552f9701dbadc0e2c1acaec4d97a3R51).
But it is ok to have ugly auto-generated code (as long as the rendered
Markdown / HTML isn't affected). What we want to read clearly is the
source template and the rendered documentation.
- Therefore, review is easier on a commit-by-commit basis 😇 


### Example

instill-ai#172 exemplifies how to add
extra sections in the Text operator.
namwoam pushed a commit to namwoam/component that referenced this pull request Jun 24, 2024
…-ai#171)

Because

- Sometimes we want to extend auto-generated docs with custom content.
- This is particularly true until JSON schema can be properly parsed by
`compogen`, which will add more detail to the complex input / output
params.

This commit

- Adds conent-injection capabilities to compogen.

### ℹ️ Info

- You'll notice extra newlines added
[everywhere](https://github.com/instill-ai/component/pull/171/files#diff-4b320521a406c97d7c1ccad3dbda779ea82206f7fdba3a7fe69c29d9834f81d0R21).
I had avoided this at the cost of a less readable
[template](https://github.com/instill-ai/component/pull/171/files#diff-3ddf390734accc49bc9993e2358b740523d552f9701dbadc0e2c1acaec4d97a3R51).
But it is ok to have ugly auto-generated code (as long as the rendered
Markdown / HTML isn't affected). What we want to read clearly is the
source template and the rendered documentation.
- Therefore, review is easier on a commit-by-commit basis 😇 


### Example

instill-ai#172 exemplifies how to add
extra sections in the Text operator.
donch1989 pushed a commit that referenced this pull request Jul 2, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.21.0-beta](v0.20.2-beta...v0.21.0-beta)
(2024-07-02)


### Features

* add mail component
([#178](#178))
([04b19d0](04b19d0))
* add read task for gcs
([#155](#155))
([77fe2fc](77fe2fc))
* add read task in bigquery component
([#156](#156))
([4d2e7ec](4d2e7ec))
* **anthropic:** add Anthropic component
([#176](#176))
([030881d](030881d))
* **anthropic:** add UsageHandler functions in anthropic
([#186](#186))
([ebaa61f](ebaa61f))
* **compogen:** add extra section with --extraContents flag'
([#171](#171))
([391bb98](391bb98))
* **instill:** remove extra-params field
([#188](#188))
([b17ff73](b17ff73))
* **redis:** simplify the TLS configuration
([#194](#194))
([0a8baf7](0a8baf7))


### Bug Fixes

* **all:** fix typos
([#174](#174))
([cb3c2fb](cb3c2fb))
* **compogen:** wrong bracket direction in substitution
([#184](#184))
([dfe8306](dfe8306))
* expose input and output for anthropic for instill credit
([#190](#190))
([a36e876](a36e876))
* update doc
([#185](#185))
([6e6639a](6e6639a))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
No open projects
Status: 👋 Done
Development

Successfully merging this pull request may close these issues.

2 participants