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 creating construct libraries #794

Closed
Chriscbr opened this issue Dec 20, 2021 · 7 comments
Closed

Add documentation for creating construct libraries #794

Chriscbr opened this issue Dec 20, 2021 · 7 comments
Labels
closed-for-staleness Issue/PR was closed due to staleness documentation Improvements or additions to documentation effort/small 1 day tops priority/p2 Dependent on community feedback. PR's are welcome :)

Comments

@Chriscbr
Copy link
Contributor

We should add a page to the website with information about how to author cdk8s construct libraries. Some of the content may overlap with the instructions for creating construct libraries for the AWS CDK, as described in the FAQ of Construct Hub: https://constructs.dev/contribute

@Chriscbr Chriscbr added documentation Improvements or additions to documentation effort/small 1 day tops labels Dec 20, 2021
@github-actions
Copy link
Contributor

This issue is now marked as stale because it hasn't seen activity for a while. Add a comment or it will be closed soon. If you wish to exclude this issue from being marked as stale, add the "backlog" label.

@github-actions github-actions bot added the stale label Feb 19, 2022
@github-actions
Copy link
Contributor

Closing this issue as it hasn't seen activity for a while. Please add a comment @mentioning a maintainer to reopen. If you wish to exclude this issue from being marked as stale, add the "backlog" label.

@Chriscbr Chriscbr reopened this Mar 24, 2022
@Chriscbr Chriscbr removed the stale label Mar 24, 2022
@felipesere
Copy link

felipesere commented Mar 25, 2022

I'd be keen to work on this as we are looking to distribute a few pre-baked charts.
At the moment, when I install our package locally into a test project I get failures due to a parent chart not being found.

For some reason, Chart.of(...) fails for

import { BasicApplication } from "shared/charts" // this is locally npm-installed

class X extends Chart {
   constructor(scope: Construct, id: string) {
     super(scope, id)
    
     new BasicApplication(this, `${id}-basic`, {
        // ... props elided....
     })
  }
}

Having spent some time in the debugger, the if (c instanceof Chart) in Chart.of(thing) fails for X, even though it extends Chart.

If I inline my entire code into e.g. vendered and change the import, all is happy...

Should I open a seprate bug for 🔼 or is that something better docs might address?

@Chriscbr
Copy link
Contributor Author

Chriscbr commented Mar 25, 2022

@felipesere Yes please open a separate bug for this! Thank you :)

Edit: I went ahead and created an issue here, since I had an inkling of where a possible cause is: cdk8s-team/cdk8s-core#401

@felipesere
Copy link

I see you already have the PRs sorted 🌶️ .
Do you still need the issues?

@Chriscbr
Copy link
Contributor Author

Nope, all good 👍

@iliapolo iliapolo added the priority/p2 Dependent on community feedback. PR's are welcome :) label Feb 6, 2023
Copy link
Contributor

github-actions bot commented Feb 6, 2024

This issue has not received any attention in 1 year and will be closed soon. If you want to keep it open, please leave a comment below @mentioning a maintainer.

@github-actions github-actions bot added the closing-soon Issue/PR will be closing soon if no response is provided label Feb 6, 2024
@github-actions github-actions bot added closed-for-staleness Issue/PR was closed due to staleness and removed closing-soon Issue/PR will be closing soon if no response is provided labels Feb 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closed-for-staleness Issue/PR was closed due to staleness documentation Improvements or additions to documentation effort/small 1 day tops priority/p2 Dependent on community feedback. PR's are welcome :)
Projects
None yet
Development

No branches or pull requests

3 participants