construct-hub 0.3.174 → 0.3.178

package/website/static/js/19.f6e4ade1.chunk.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"static/js/19.f6e4ade1.chunk.js","mappings":"oTAGaA,EAAyB,SAAC,GAAD,IAAGC,EAAH,EAAGA,SAAH,OACpC,UAAC,KAAD,CAAKC,GAAG,QAAQC,MAAM,WAAWC,EAAE,OAAOC,EAAE,OAA5C,UACGJ,GACD,SAAC,KAAD,CAAKK,GAAI,EAAGC,MAAM,aCHTC,EAAgC,SAAC,GAAD,IAAGP,EAAH,EAAGA,SAAH,OAC3C,SAAC,KAAD,CAAKC,GAAG,UAAUI,GAAI,GAAIC,MAAM,OAAhC,UACE,SAAC,KAAD,CAASE,GAAG,KAAKC,GAAG,OAAOC,UAAU,SAArC,SACGV,O,WCSMW,EAA2C,SAAC,GAAD,IACtDC,EADsD,EACtDA,SACAZ,EAFsD,EAEtDA,SAFsD,OAItD,UAAC,KAAD,YACE,UAAC,KAAD,YACE,SAAC,KAAD,CAAKa,KAAK,IAAIR,GAAI,EAAGK,UAAU,OAA/B,UACE,SAAC,KAAD,CAASF,GAAG,KAAKM,GAAI,EAAGC,KAAK,KAA7B,SACGH,OAGL,SAAC,KAAD,QAEF,SAAC,KAAD,CAAgBI,GAAI,GAAIX,GAAI,EAA5B,UACE,SAAC,KAAD,CACEH,MAAM,WACNe,SAAS,KACTC,GAAI,CAAEC,EAAG,CAAEC,UAAW,IAAKC,aAAc,MAH3C,SAKGrB,U,UC3BIsB,EAA2C,SAAC,GAAD,IACtDC,EADsD,EACtDA,KACAvB,EAFsD,EAEtDA,SAFsD,OAItD,SAACwB,EAAA,EAAD,CACEtB,MAAM,UACNuB,YAAY,EACZF,KAAMA,EACNG,eAAe,YAJjB,SAMG1B,KCDQ2B,EAAiD,SAAC,GAAD,IAC5DC,EAD4D,EAC5DA,QACA5B,EAF4D,EAE5DA,SAF4D,OAI5D,UAAC,KAAD,YACE,UAAC,KAAD,YACE,SAAC,KAAD,CAAKa,KAAK,IAAIH,UAAU,OAAxB,UACE,SAAC,KAAD,CAASF,GAAG,KAAKM,GAAI,EAAGe,GAAI,EAAGd,KAAK,KAApC,SACGa,OAGL,SAAC,KAAD,QAEF,SAAC,KAAD,CAAgBT,EAAG,EAAnB,UACE,SAAC,KAAD,CAAWW,eAAa,EAAC1B,EAAE,OAA3B,SACGJ,U,oCC5BI+B,EAAiD,SAAC,GAAD,IAC5D/B,EAD4D,EAC5DA,SACGgC,GAFyD,mBAI5D,SAAC,MAAD,gBAAWF,eAAa,GAAKE,GAA7B,aACGhC,O,gFCRQiC,EAAW,CACtBC,WAAY,CACVC,MAAO,CACLC,KAAM,oBAGVC,KAAM,CACJF,MAAO,CACLC,KAAM,cAGVE,IAAK,CACHH,MAAO,CACLC,KAAM,oCAGVG,eAAgB,CACdJ,MAAO,CACLC,KAAM,yBAGVI,OAAQ,CACNL,MAAO,CACLC,KAAM,gBAGVK,UAAW,CACTN,MAAO,CACLC,KAAM,oBAGVM,SAAU,CACRC,KAAM,CACJC,SAAU,aAEZT,MAAO,CACLC,KAAM,mB,sBCVCS,GATD,CACV,6DACA,wNACA,yDACA,qKACA,qBACA,qCACAC,KAAK,KAE2C,SAAC,GAI5C,IAHL9C,EAGI,EAHJA,SACA+C,EAEI,EAFJA,KACAC,EACI,EADJA,SAEMC,GAAgBC,EAAAA,EAAAA,IAAYjB,EAASe,KAE3CG,EAAAA,EAAAA,YAAU,WACRF,MACC,CAACA,IAEJ,MAA8CF,EAAtCK,OAAAA,OAAR,SAAuBC,EAAuBN,EAAvBM,MAAOC,EAAgBP,EAAhBO,YACxBC,EAAiBH,EAAM,UAAMC,EAAN,oBAAgCA,EAE7D,OACE,iCACE,UAACG,EAAA,EAAD,YACGC,GAID,iBAAMC,QAAQ,sCAAsCtB,KAAK,cACzD,iBAAMuB,QAAQ,WAEd,2BAAQJ,KACR,iBAAMG,QAASH,EAAgBK,SAAS,cACxC,iBAAMF,QAASH,EAAgBnB,KAAK,mBACpC,iBAAMsB,QAAQ,UAAUtB,KAAK,kBAE7B,iBAAMsB,QAASJ,EAAalB,KAAK,iBACjC,iBAAMsB,QAASJ,EAAaM,SAAS,oBACrC,iBAAMF,QAASJ,EAAalB,KAAK,2BAElCpC,Q,yIC/CM6D,EAAgC,kBAC3C,SAAChB,EAAA,EAAD,CACEE,KAAM,CACJO,YAAa,6CACbD,MAAO,cAETL,SAAS,aALX,UAOE,UAACjD,EAAA,GAAD,YACE,SAACA,EAAA,GAAD,6CAEA,UAAC,KAAD,CAAW+B,eAAa,EAACgC,aAAW,EAACC,aAAc,CAAC,GAApD,WACE,UAAChE,EAAA,GAAD,CAASa,SAAS,+CAAlB,WACE,UAAC,KAAD,4EACiE,KAC/D,SAACb,EAAA,GAAD,CAASwB,KAAK,yBAAd,0BAFF,qKAQA,UAAC,KAAD,0KAG0B,qCAH1B,oBAGiE,KAC/D,SAACxB,EAAA,GAAD,CAASwB,KAAK,8BAAd,kBAJF,oNAWA,UAAC,KAAD,2QAIuD,KACrD,SAACxB,EAAA,GAAD,CAASwB,KAAI,UAAKyC,EAAAA,GAAL,eAAb,oCAKF,UAAC,KAAD,yJAGe,KACb,UAACjE,EAAA,GAAD,CAASwB,KAAK,sGAAd,6EACmE,IADnE,kBAGW,IAPb,OAQK,SAACxB,EAAA,GAAD,CAASwB,KAAK,uBAAd,qBARL,QAWA,UAAC,KAAD,gJAEqE,KACnE,SAACxB,EAAA,GAAD,CAASwB,KAAK,+DAAd,+CAMJ,UAACxB,EAAA,GAAD,CAASa,SAAS,qGAAlB,WACE,SAAC,KAAD,kHAIA,UAAC,KAAD,CAAaM,GAAI,CAAE+C,GAAI,CAAEC,GAAI,IAA7B,WACE,UAAC,KAAD,YACE,qDADF,oSAQA,UAAC,KAAD,YACE,kDADF,ibAUA,UAAC,KAAD,YACE,gDADF,oeAWA,UAAC,KAAD,YACE,mDADF,wLAOA,UAAC,KAAD,YACE,uDADF,sfAYA,UAAC,KAAD,YACE,iEADF,qMAOA,UAAC,KAAD,YACE,mFAEU,IAHZ,+aAeJ,UAACnE,EAAA,GAAD,CAASa,SAAS,4EAAlB,WACE,SAAC,KAAD,wPAOA,UAAC,KAAD,CAAeM,GAAI,CAAE+C,GAAI,CAAEC,GAAI,IAA/B,WACE,UAAC,KAAD,YACE,mEADF,+CAEmC,KACjC,SAACnE,EAAA,GAAD,CAASwB,KAAK,oEAAd,kCAHF,0DASA,UAAC,KAAD,YACE,kDADF,yHAMA,UAAC,KAAD,YACE,mEADF,iXAUA,UAAC,KAAD,YACE,8CADF,scAWA,UAAC,KAAD,YACE,oDADF,uJAMA,UAAC,KAAD,YACE,qDADF,mVAQA,UAAC,KAAD,YACE,0CADF,qKAMA,UAAC,KAAD,YACE,oDADF,oGAKA,UAAC,KAAD,YACE,6DADF,+KASJ,SAACxB,EAAA,GAAD,CAASa,SAAS,wDAAlB,UACE,UAAC,KAAD,sUAKiD,KAC/C,SAACb,EAAA,GAAD,CAASwB,KAAI,UAAKyC,EAAAA,GAAL,eAAb,kBANF,UAaF,SAACjE,EAAA,GAAD,CAASa,SAAS,uDAAlB,UACE,SAAC,KAAD,mKAOF,SAACb,EAAA,GAAD,CAASa,SAAS,4DAAlB,UACE,SAAC,KAAD,qTASF,UAACb,EAAA,GAAD,CAASa,SAAS,6DAAlB,uEAC6D,KAC3D,SAACb,EAAA,GAAD,CAASwB,KAAK,2CAAd,4CAFF,uEAKuE,KACrE,SAACxB,EAAA,GAAD,CAASwB,KAAK,mBAAd,+CAKF,SAACxB,EAAA,GAAD,CAASa,SAAS,kDAAlB,UACE,UAAC,KAAD,6BACkB,KAChB,SAACb,EAAA,GAAD,CAASwB,KAAK,mBAAd,+BAFF","sources":["components/FAQ/FAQ.tsx","components/FAQ/FAQHeading.tsx","components/FAQ/FAQItem.tsx","components/FAQ/FAQLink.tsx","components/FAQ/FAQSection.tsx","components/FAQ/FAQSections.tsx","constants/pageInfo.ts","components/Page/Page.tsx","views/Contribute/Contribute.tsx"],"sourcesContent":["import { Box } from \"@chakra-ui/react\";\nimport type { FunctionComponent } from \"react\";\n\nexport const FAQ: FunctionComponent = ({ children }) => (\n  <Box bg=\"white\" color=\"blue.800\" h=\"100%\" w=\"100%\">\n    {children}\n    <Box py={5} width=\"100%\" />\n  </Box>\n);\n","import { Box, Heading } from \"@chakra-ui/react\";\nimport type { FunctionComponent } from \"react\";\n\nexport const FAQHeading: FunctionComponent = ({ children }) => (\n  <Box bg=\"gray.50\" py={20} width=\"100%\">\n    <Heading as=\"h1\" mx=\"auto\" textAlign=\"center\">\n      {children}\n    </Heading>\n  </Box>\n);\n","import {\n  Heading,\n  Text,\n  AccordionIcon,\n  AccordionButton,\n  AccordionItem,\n  AccordionPanel,\n  Box,\n} from \"@chakra-ui/react\";\nimport type { FunctionComponent, ReactChild } from \"react\";\n\nexport interface FAQItemProps {\n  question: ReactChild;\n}\n\nexport const FAQItem: FunctionComponent<FAQItemProps> = ({\n  question,\n  children,\n}) => (\n  <AccordionItem>\n    <AccordionButton>\n      <Box flex=\"1\" py={2} textAlign=\"left\">\n        <Heading as=\"h3\" ml={8} size=\"sm\">\n          {question}\n        </Heading>\n      </Box>\n      <AccordionIcon />\n    </AccordionButton>\n    <AccordionPanel px={12} py={4}>\n      <Text\n        color=\"blue.800\"\n        fontSize=\"md\"\n        sx={{ p: { marginTop: \"0\", marginBottom: \"4\" } }}\n      >\n        {children}\n      </Text>\n    </AccordionPanel>\n  </AccordionItem>\n);\n","import { FunctionComponent } from \"react\";\nimport { ExternalLink } from \"../../components/ExternalLink\";\n\nexport interface FAQLinkProps {\n  href: string;\n}\n\nexport const FAQLink: FunctionComponent<FAQLinkProps> = ({\n  href,\n  children,\n}) => (\n  <ExternalLink\n    color=\"inherit\"\n    hasWarning={false}\n    href={href}\n    textDecoration=\"underline\"\n  >\n    {children}\n  </ExternalLink>\n);\n","import {\n  AccordionIcon,\n  AccordionButton,\n  AccordionItem,\n  AccordionPanel,\n  Heading,\n  Box,\n  Accordion,\n} from \"@chakra-ui/react\";\n\nimport type { FunctionComponent } from \"react\";\n\nexport interface FAQSectionProps {\n  heading: string;\n}\n\nexport const FAQSection: FunctionComponent<FAQSectionProps> = ({\n  heading,\n  children,\n}) => (\n  <AccordionItem>\n    <AccordionButton>\n      <Box flex=\"1\" textAlign=\"left\">\n        <Heading as=\"h2\" ml={4} my={4} size=\"lg\">\n          {heading}\n        </Heading>\n      </Box>\n      <AccordionIcon />\n    </AccordionButton>\n    <AccordionPanel p={0}>\n      <Accordion allowMultiple w=\"100%\">\n        {children}\n      </Accordion>\n    </AccordionPanel>\n  </AccordionItem>\n);\n","import { Accordion, AccordionProps } from \"@chakra-ui/react\";\nimport type { FunctionComponent } from \"react\";\n\nexport const FAQSections: FunctionComponent<AccordionProps> = ({\n  children,\n  ...accordionProps\n}) => (\n  <Accordion allowMultiple {...accordionProps}>\n    {children}\n  </Accordion>\n);\n","export const pageInfo = {\n  contribute: {\n    event: {\n      name: \"Contribute Load\",\n    },\n  },\n  home: {\n    event: {\n      name: \"Home Load\",\n    },\n  },\n  faq: {\n    event: {\n      name: \"Frequently Asked Questions Load\",\n    },\n  },\n  packageProfile: {\n    event: {\n      name: \"Package Profile Load\",\n    },\n  },\n  search: {\n    event: {\n      name: \"Search Load\",\n    },\n  },\n  siteTerms: {\n    event: {\n      name: \"Site Terms Load\",\n    },\n  },\n  notFound: {\n    page: {\n      pageType: \"errorPage\",\n    },\n    event: {\n      name: \"404 Page Load\",\n    },\n  },\n} as const;\n","import { FunctionComponent, useEffect } from \"react\";\nimport { Helmet } from \"react-helmet\";\nimport { pageInfo } from \"../../constants/pageInfo\";\nimport { usePageView } from \"../../contexts/Analytics\";\n\nexport interface PageProps {\n  pageName: keyof typeof pageInfo;\n  meta: {\n    suffix?: boolean;\n    title: string;\n    description: string;\n  };\n}\n\n// Should be the same as the \"real\" CSP, except most things come from HTTP\n// instead of HTTPS (because it is protocol-relative, and the dev site is\n// served over plain HTTP).\nconst csp = [\n  \"default-src 'self' 'unsafe-inline' http://*.awsstatic.com;\",\n  \"connect-src 'self' https://*.shortbread.aws.dev http://*.shortbread.aws.dev http://a0.awsstatic.com/ http://amazonwebservices.d2.sc.omtrdc.net http://aws.demdex.net http://dpm.demdex.net http://cm.everesttech.net;\",\n  \"frame-src http://aws.demdex.net http://dpm.demdex.net;\",\n  \"img-src 'self' https://* http://a0.awsstatic.com/ http://amazonwebservices.d2.sc.omtrdc.net http://aws.demdex.net http://dpm.demdex.net http://cm.everesttech.net;\",\n  \"object-src 'none';\",\n  \"style-src 'self' 'unsafe-inline';\",\n].join(\" \");\n\nexport const Page: FunctionComponent<PageProps> = ({\n  children,\n  meta,\n  pageName,\n}) => {\n  const trackPageView = usePageView(pageInfo[pageName]);\n\n  useEffect(() => {\n    trackPageView();\n  }, [trackPageView]);\n\n  const { suffix = true, title, description } = meta;\n  const formattedTitle = suffix ? `${title} - Construct Hub` : title;\n\n  return (\n    <>\n      <Helmet>\n        {process.env.NODE_ENV === \"development\" && (\n          <meta content={csp} httpEquiv=\"Content-Security-Policy\" />\n        )}\n\n        <meta content=\"width=device-width, initial-scale=1\" name=\"viewport\" />\n        <meta charSet=\"utf-8\" />\n\n        <title>{formattedTitle}</title>\n        <meta content={formattedTitle} property=\"og:title\" />\n        <meta content={formattedTitle} name=\"twitter:title\" />\n        <meta content=\"summary\" name=\"twitter:card\" />\n\n        <meta content={description} name=\"description\" />\n        <meta content={description} property=\"og:description\" />\n        <meta content={description} name=\"twitter:description\" />\n      </Helmet>\n      {children}\n    </>\n  );\n};\n","import {\n  Accordion,\n  OrderedList,\n  ListItem,\n  Text,\n  UnorderedList,\n} from \"@chakra-ui/react\";\nimport type { FunctionComponent } from \"react\";\nimport { FAQ, FAQHeading, FAQItem, FAQLink } from \"../../components/FAQ\";\nimport { Page } from \"../../components/Page\";\nimport { CONSTRUCT_HUB_REPO_URL } from \"../../constants/links\";\n\nexport const Contribute: FunctionComponent = () => (\n  <Page\n    meta={{\n      description: \"Learn about contributing to Construct Hub.\",\n      title: \"Contribute\",\n    }}\n    pageName=\"contribute\"\n  >\n    <FAQ>\n      <FAQHeading>Contributing to Construct Hub</FAQHeading>\n\n      <Accordion allowMultiple allowToggle defaultIndex={[0]}>\n        <FAQItem question=\"How can I add my construct to Construct Hub?\">\n          <Text>\n            Constructs intended for Construct Hub must be published to the{\" \"}\n            <FAQLink href=\"https://www.npmjs.com/\">npm Registry</FAQLink> under\n            Apache, BSD, EPL, MPL-2.0, ISC and CDDL or MIT open source licenses\n            and annotated with a keyword recognized by Construct Hub (awscdk,\n            cdk8s, or cdktf).\n          </Text>\n\n          <Text>\n            Additionally, since one of the main goals of Construct Hub is to\n            enable an ecosystem of constructs that can be consumed by all CDK\n            languages, your library <strong>must</strong> be compiled with{\" \"}\n            <FAQLink href=\"https://aws.github.io/jsii/\">JSII</FAQLink>, a\n            TypeScript-based tool for building multi-language libraries.\n            Construct Hub leverages the type information produced by the JSII\n            compiler to render a rich multi-language API reference for each\n            construct.\n          </Text>\n\n          <Text>\n            Construct Hub continuously monitors the npm Registry. Packages that\n            meet the above requirements appear in Construct Hub in about 30\n            minutes. If your package does not appear in Construct Hub, but meets\n            these requirements, please file an issue against our{\" \"}\n            <FAQLink href={`${CONSTRUCT_HUB_REPO_URL}/issues/new`}>\n              GitHub repository.\n            </FAQLink>\n          </Text>\n\n          <Text>\n            The community has provided some great resources about publishing\n            construct libraries that meet Construct Hub requirements. For\n            example, see{\" \"}\n            <FAQLink href=\"https://dev.to/aws-builders/a-beginner-s-guide-to-create-aws-cdk-construct-library-with-projen-5eh4\">\n              “A Beginner&apos;s Guide to Create AWS CDK ConstructLibrary with{\" \"}\n              projen”\n            </FAQLink>{\" \"}\n            by <FAQLink href=\"https://hayao-k.dev/\">hayao-k</FAQLink>.\n          </Text>\n\n          <Text>\n            If you already have a library written in TypeScript and want to\n            migrate it to JSII so it can be included in Construct Hub, see the{\" \"}\n            <FAQLink href=\"https://aws.github.io/jsii/user-guides/#library-author-guide\">\n              JSII library author guide.\n            </FAQLink>\n          </Text>\n        </FAQItem>\n\n        <FAQItem question=\"What are the best practices for improving discoverability of a construct library on Construct Hub?\">\n          <Text>\n            To improve your construct library’s visibility on Construct Hub,\n            follow these best practices:\n          </Text>\n          <OrderedList sx={{ li: { mt: 4 } }}>\n            <ListItem>\n              <strong>Helpful description.</strong> Publish your library with a\n              description. Libraries without description have lower chances to\n              be discovered by users. When you write your library’s description,\n              think: Why would someone use it? What makes it unique? Make the\n              description as accurate and differentiated as possible.\n            </ListItem>\n\n            <ListItem>\n              <strong>Helpful keywords.</strong> Publish your library with\n              helpful keywords, ones that can help potential users to find your\n              package. Helpful keywords can be technologies that are being used\n              by the library, use cases the library is useful for, service names\n              that are being used by the library etc. For example: ‘Monitoring’,\n              ‘Kubernetes’, ‘Cost Management’, ‘Websites’, ‘AI’, ‘Containers’\n              and more.\n            </ListItem>\n\n            <ListItem>\n              <strong>Helpful README.</strong> Review your library’s README\n              file. Is it developer-friendly? That is, can developers quickly\n              understand the use case you’re trying to solve? Does your README\n              make it easy to get started with your library? Does it explain how\n              your library is different from other libraries? Is it easy to\n              understand at first glance the value developers gain from the\n              library? For more information see *“Q: What are the best practices\n              for a developer-friendly README file?”.*\n            </ListItem>\n\n            <ListItem>\n              <strong>API documentation.</strong> Document the library classes,\n              methods, properties in the library’s code. Construct Hub will\n              display this information when it automatically generates the API\n              documentation.\n            </ListItem>\n\n            <ListItem>\n              <strong>Maintain your library.</strong> Developers prefer\n              libraries that are updated on a regular basis. Our experience\n              shows that successful libraries are those where publishers engage\n              and collaborate with the user community, respond to issues and\n              pull requests, fix bugs, and add capabilities. To gain more\n              developers trust, maintain the releases section on your code\n              repository and make sure to describe the changes between different\n              releases. You may consider to link the libraries you’ve published\n              with your code repository.\n            </ListItem>\n\n            <ListItem>\n              <strong>AWS Partner Network (APN) badge.</strong> If you’re an AWS\n              partner and you are publishing a library for your offering, please\n              reach out to us and we will be happy to add a badge to your\n              libraries with your company’s name.\n            </ListItem>\n\n            <ListItem>\n              <strong>\n                Enable support for multiple programming languages.\n              </strong>{\" \"}\n              Make your library usable by a broader set of users and increase\n              its value to the ecosystem. Starting with your library written in\n              TypeScript, JSII will create packages in the other CDK programming\n              languages. Construct Hub will then automatically generate API\n              reference and transliterate code samples. All you need to do is to\n              follow the instructions under *“Q: How can I add my construct to\n              Construct Hub?”.*\n            </ListItem>\n          </OrderedList>\n        </FAQItem>\n\n        <FAQItem question=\"What are the best practices for writing a developer-friendly README file?\">\n          <Text>\n            Developer-friendly READMEs help readers quickly understand your\n            library’s relevance to their needs and its unique value in\n            comparison to similar libraries on the Construct Hub. Below is a\n            suggestion for a README file structure:\n          </Text>\n\n          <UnorderedList sx={{ li: { mt: 4 } }}>\n            <ListItem>\n              <strong>State and maturity of the library.</strong> Start your\n              READMEs with helpful badges like{\" \"}\n              <FAQLink href=\"https://www.npmjs.com/package/cdk-codepipeline-badge-notification\">\n                CDK pipelines badges\n              </FAQLink>\n              . It will help users see the state of your package.\n            </ListItem>\n\n            <ListItem>\n              <strong>Short description</strong>. What does this library do?\n              Which use case does it solve? Which technologies and services does\n              it use or support?\n            </ListItem>\n\n            <ListItem>\n              <strong>What is unique about this library?</strong> Help readers\n              quickly find the right library for their needs by stating its\n              special advantages right up front. How does it compare to other\n              libraries addressing the same need or that use the same\n              technologies and services? You don’t need an explicit “us vs.\n              them” feature checklist; just make sure you communicate your\n              library’s unique value.\n            </ListItem>\n\n            <ListItem>\n              <strong>Code samples.</strong> Include as many complete and\n              working code samples as you can to help developers quickly\n              understand how they can use your library. Some developers start\n              reading code samples before anything else. Write your code samples\n              in TypeScript, and Construct Hub will transliterate them to the\n              other programming languages your library supports. A good practice\n              is to include a minimal code sample of how to use your library in\n              the first page of your README.\n            </ListItem>\n\n            <ListItem>\n              <strong>Author information.</strong> Share information about you,\n              other packages you’ve published, and additional helpful links that\n              can improve your credibility with readers.\n            </ListItem>\n\n            <ListItem>\n              <strong>License and support.</strong> Include a “License” and\n              “Contributing” sections that invite users to contribute via links\n              to your source code repository and issue tracker. (Construct Hub\n              provides “License” and “Provide Feedback” in your library’s\n              package page, but it’s convenient to have them in the README too.)\n            </ListItem>\n\n            <ListItem>\n              <strong>Diagrams.</strong> Diagrams always help readers quickly\n              understand what a library does. Consider adding diagrams for\n              libraries that create multiple services that work together.\n            </ListItem>\n\n            <ListItem>\n              <strong>Explanatory videos.</strong> Consider sharing links to\n              videos that can help potential customers engage with your library.\n            </ListItem>\n\n            <ListItem>\n              <strong>Absolute links vs. relative.</strong> Use absolute links\n              (those that start with http:// or https://) and not relative\n              links. Relative links are prone to breaking when the content is\n              shared elsewhere.\n            </ListItem>\n          </UnorderedList>\n        </FAQItem>\n\n        <FAQItem question=\"Why isn’t my package displayed on Construct Hub?\">\n          <Text>\n            Construct Hub includes publicly-available constructs that are\n            JSII-compatible and that were published to the npm Registry with a\n            permissive open-source license and a CDK keyword: aws-cdk, cdk8s, or\n            cdktf. If you believe your package qualifies, but it still does not\n            appear in Construct Hub, please raise an issue{\" \"}\n            <FAQLink href={`${CONSTRUCT_HUB_REPO_URL}/issues/new`}>\n              here\n            </FAQLink>\n            .\n          </Text>\n        </FAQItem>\n\n        <FAQItem question=\"Can I update my package after it has been displayed?\">\n          <Text>\n            Yes, you can and should! After you publish a new valid version to\n            the public npm Registry, it should appear on Construct Hub in about\n            30 minutes.\n          </Text>\n        </FAQItem>\n\n        <FAQItem question=\"How can I report a bug or contribute code to a construct?\">\n          <Text>\n            Each package is owned by its publisher, so contributions, such as\n            bug reports and pull requests, should be made via the repository\n            link provided by the publisher. You may press the ‘Provide feedback’\n            link at the package page to open a new issue in at the package’s\n            repository.\n          </Text>\n        </FAQItem>\n\n        <FAQItem question=\"How can I participate in link the Construct Hub community?\">\n          Construct Hub is itself an open-source construct! Join the{\" \"}\n          <FAQLink href=\"https://github.com/cdklabs/construct-hub\">\n            Construct Hub GitHub community\n          </FAQLink>\n          . You are also welcome to join the #construct-hub-dev channel in the{\" \"}\n          <FAQLink href=\"https://cdk.dev/\">\n            CDK community Slack workspace\n          </FAQLink>\n        </FAQItem>\n\n        <FAQItem question=\"Is there a Slack channel for the CDK community?\">\n          <Text>\n            Please join the{\" \"}\n            <FAQLink href=\"https://cdk.dev/\">CDK Slack channel</FAQLink>. This\n            Slack channel is managed by the CDK community, for the CDK\n            community.\n          </Text>\n        </FAQItem>\n      </Accordion>\n    </FAQ>\n  </Page>\n);\n"],"names":["FAQ","children","bg","color","h","w","py","width","FAQHeading","as","mx","textAlign","FAQItem","question","flex","ml","size","px","fontSize","sx","p","marginTop","marginBottom","FAQLink","href","ExternalLink","hasWarning","textDecoration","FAQSection","heading","my","allowMultiple","FAQSections","accordionProps","pageInfo","contribute","event","name","home","faq","packageProfile","search","siteTerms","notFound","page","pageType","Page","join","meta","pageName","trackPageView","usePageView","useEffect","suffix","title","description","formattedTitle","Helmet","process","content","charSet","property","Contribute","allowToggle","defaultIndex","CONSTRUCT_HUB_REPO_URL","li","mt"],"sourceRoot":""}