{"id":"059b826225c1c927ac06488787e3c69850102c27e12848161c9e9b0b71b11e79","type":"Contented","path":"/ballad","modifiedDate":1686373756200,"sections":[],"fields":{"title":"Ballad of Engineering"},"html":"

Ballad of Engineering

\n
npm i
\n

While at SaaS Team

\n

Engineer Write code

\n
echo \"function foo()\" > bar.js\njest bar.js
\n

Engineer Write Documentation

\n
contented write\necho \"write about foo()\" > bar.md\n\ngit commit -m \"feat(packages): foo() is bar\"\ngit push
\n

Git Workflow CI

\n
jest --ci --coverage &&\n  github update workflow['CI/Build'] = Success with 99%\n\ncontented build &&\n  github update workflow['CI/Contented'] = Success
\n

Git Workflow CD

\n
contented generate &&\n  netlify deploy\n\ncontented build &&\n  npm publish
\n

While at Product/Marketing Team

\n

Engineer Implement Page

\n
import { Index as aDocs } from '@company/your-product-a';\nimport { Index as bDocs } from '@company/your-product-b';\n\nasync function findContent(path) {\n  let content = aDocs.find((file) => file.path === path);\n  if (content) {\n    return require(`@company/your-product-a/${content.type}/${content.id}.json`);\n  }\n\n  content = bDocs.find((file) => file.path === path);\n  if (content) {\n    return require(`@company/your-product-b/${content.type}/${content.id}.json`);\n  }\n}\n\nexport async function getStaticProps({ params }) {\n  const path = `/${params?.slug?.join('/') ?? ''}`;\n  return {\n    props: {\n      doc: await findContent(path),\n    },\n  };\n}\n\nexport default function Page({ doc }) {\n  return (\n    <ContentProse>\n      <h1>{doc.title}</h1>\n      <div dangerouslySetInnerHTML={{ __html: doc.body.html }} />\n    </ContentProse>\n  );\n}
\n

Dependabot

\n
git commit -m \"bump(deps): bump @your/documentation from 0.0.0 to 0.0.1\"\ngit push\ngithub create pr\n\ncontented generate\n  && netlify deploy preview
\n

Engineer Review Changes

\n
github open pr\ngithub click Netlify Preview\ngithub lgtm
","headings":[{"depth":1,"id":"ballad-of-engineering","title":"Ballad of Engineering","children":[{"depth":2,"id":"while-at-saas-team","title":"While at SaaS Team","children":[{"depth":3,"id":"engineer-write-code","title":"Engineer Write code","children":[]},{"depth":3,"id":"engineer-write-documentation","title":"Engineer Write Documentation","children":[]},{"depth":3,"id":"git-workflow-ci","title":"Git Workflow CI","children":[]},{"depth":3,"id":"git-workflow-cd","title":"Git Workflow CD","children":[]}]},{"depth":2,"id":"while-at-productmarketing-team","title":"While at Product/Marketing Team","children":[{"depth":3,"id":"engineer-implement-page","title":"Engineer Implement Page","children":[]},{"depth":3,"id":"dependabot","title":"Dependabot","children":[]},{"depth":3,"id":"engineer-review-changes","title":"Engineer Review Changes","children":[]}]}]}]}