Skip to content

Latest commit

 

History

History
647 lines (441 loc) · 42.3 KB

ARCHIVED_CHANGELOG.md

File metadata and controls

647 lines (441 loc) · 42.3 KB

3.0.0 (2020-05-08)

This release introduces some breaking changes, as documented below.

  • Dropping node v10 support
  • The @commercetools-docs/broken-link-checker package has been removed. The NPM package is still available but it's marked as deprecated. As a replacement, we recommend using the linkinator package.
  • The @commercetools-docs/gatsby-theme-api-docs is now a theme "add-on" (read more about "add-ons" below).
  • The @commercetools-docs/gatsby-transformer-code-examples is now a theme "add-on" (read more about "add-ons" below) and has been renamed to @commercetools-docs/gatsby-theme-code-examples.

Introducing Gatsby Theme Add-Ons

A theme add-on is a Gatsby Theme that exposes React components to be injected into the MDX provider of the core theme.

Gatsby enables a child theme to use component shadowing (see Theme overrides). However, with multiple themes, the shadowed components are only loaded from the last theme in the Gatsby configuration. To solve this problem, a commercetools-docs Gatsby Theme can be used as an add-on, allowing multiple add-ons to provide additional components to be available in MDX without having to manually import them into every page.

When using add-on themes, a proxy export file will be generated in the websites src/@commercetools-docs/gatsby-theme-docs/overrides folder to leverage Gatsby's component shadowing (see Theme overrides). This file provides all the exported components from the add-on packages. For a component to be exported by an add-on package it has to be exported from index.js in the add-on package root.

To safely configure theme add-ons, use the configureThemeWithAddOns function in the websites's gatsby-config.js:

const {
  configureThemeWithAddOns,
} = require('@commercetools-docs/gatsby-theme-docs/configure-theme');

module.exports = {
  plugins: [
    ...configureThemeWithAddOns({
      // Pass the normal theme options
      websiteKey: 'my-website-key',
      // Set up the theme add-ons
      addOns: [
        '@commercetools-docs/gatsby-theme-foo',
        {
          resolve: '@commercetools-docs/gatsby-theme-bar',
          options: {
            // ...
          },
        },
      ],
    }),
  ],
};

🐛 Type: Bug

  • gatsby-theme-docs
    • #413 fix: element keys should be unique (@davifantasia)
    • #407 fix(theme): render proper 404 page as a content page (@emmenko)
    • #399 fix: inconsistent url and title or index nav (@davifantasia)
    • #394 fix(theme): gracefully handle missing heading level in TOC (@emmenko)
    • #388 fix(theme-docs): Render mdx commonmark compliant (@nkuehn)
    • #384 fix(theme): sticky page nav and scrolling container (@emmenko)
    • #380 fix(theme): rss link to be treated as external link (@emmenko)
  • gatsby-transformer-raml
  • gatsby-theme-docs, ui-kit
    • #382 fix(theme): proptype warnings and mapping of some md elements (@emmenko)

💥 Type: Breaking Change

  • broken-link-checker
    • #424 feat: use linkinator, drop broken-link-checker (@emmenko)
  • gatsby-theme-docs
  • gatsby-theme-api-docs, gatsby-theme-code-examples, gatsby-theme-docs
    • #422 feat: implement add-ons mechanism to merge markdown components from different add-on themes (@emmenko)
  • gatsby-theme-api-docs
    • #412 refactor(api-theme): compose themes in website instead of inheriting (@nkuehn)

🔮 Type: Chore

  • #383 refactor(ci): to not use cypress github action (@emmenko)

💅 Type: Enhancement

  • writing-style
  • Other
    • #398 enhancement(workspace): set the window title better find the window (@nkuehn)

🚀 Type: New Feature

  • gatsby-theme-code-examples, gatsby-theme-constants, gatsby-theme-docs
  • gatsby-theme-api-docs, gatsby-theme-code-examples, gatsby-theme-docs
    • #422 feat: implement add-ons mechanism to merge markdown components from different add-on themes (@emmenko)
  • gatsby-theme-docs, ui-kit
  • gatsby-theme-docs
  • gatsby-theme-api-docs, gatsby-theme-docs
    • #375 Release Notes: Render excerpt in list with reduced formatting, show read more. (@nkuehn)

⛑ Type: Refactoring

  • gatsby-theme-code-examples, gatsby-theme-docs, gatsby-transformer-code-examples
    • #419 refactor(code-examples): make it a gatsby theme (@emmenko)
  • gatsby-theme-api-docs
    • #412 refactor(api-theme): compose themes in website instead of inheriting (@nkuehn)
  • gatsby-theme-api-docs, gatsby-theme-docs
    • #375 Release Notes: Render excerpt in list with reduced formatting, show read more. (@nkuehn)

🤖 Type: Dependencies

  • gatsby-theme-api-docs, gatsby-theme-docs, gatsby-transformer-mdx-introspection, ramldoc-generator, writing-style
  • Other
  • gatsby-theme-docs, ui-kit
  • broken-link-checker, gatsby-theme-api-docs, gatsby-theme-docs, gatsby-transformer-mdx-introspection, ramldoc-generator

2.5.0 (2020-04-17)

🐛 Type: Bug

  • gatsby-theme-docs, gatsby-transformer-code-examples
    • #370 fix(theme): to not restrict content page nodes for specific filesystem (@emmenko)
  • writing-style
    • #366 Writing Style Linter: Update vale and prevent binary from being published (@nkuehn)
  • gatsby-theme-docs
    • #347 fix(theme): to use height auto for small screens (@emmenko)
    • #351 fix(theme): remove check for zeit github branch (@emmenko)
    • #348 fix(theme): dynamically render the cookie consent scripts only on *.commercetools.com domain (@nkuehn)
    • #350 fix: leftovers of release notes layout implementation (@emmenko)

🔮 Type: Chore

  • #353 chore(ci): add workflow to verify PR labels are assigned (@emmenko)

💅 Type: Enhancement

  • gatsby-theme-docs
    • #331 Nav Content: Add Integrations marketplace to meta nav (@nkuehn)
  • writing-style
    • #356 Writing Style: match the date formatting style hint to our actual styleguide rule (@nkuehn)

🚀 Type: New Feature

  • gatsby-theme-docs
  • gatsby-theme-docs, ui-kit
  • gatsby-theme-api-docs, gatsby-theme-docs
    • #336 feat(theme): implement release notes page layout (@emmenko)

⛑ Type: Refactoring

  • gatsby-theme-docs
  • gatsby-theme-api-docs, gatsby-theme-docs, gatsby-transformer-mdx-introspection, gatsby-transformer-raml-legacy, gatsby-transformer-raml, ramldoc-generator, ui-kit
    • #355 refactor(theme): use uikit Stamp component for release note types (@emmenko)

🤖 Type: Dependencies

  • writing-style
    • #366 Writing Style Linter: Update vale and prevent binary from being published (@nkuehn)
  • ramldoc-generator

2.4.0 (2020-04-03)

🐛 Type: Bug

  • gatsby-theme-api-docs
    • #330 fix: query parameters types that are objects now render as links (@davifantasia)
  • writing-style
    • #333 fix(writing-style): cover the last few cases from the existing docs (@nkuehn)

🔮 Type: Chore

  • gatsby-theme-docs
    • #334 chore: update cookie consent banner script (@nkuehn)

🚀 Type: New Feature

  • gatsby-theme-docs

    This feature is still under development.

🤖 Type: Dependencies

  • gatsby-theme-api-docs, gatsby-theme-docs

2.3.0 (2020-03-30)

🐛 Type: Bug

  • writing-style
    • #323 feat(writing-style): upgrade to vale 2.1.0, don't let vale fail when called from the VSCode plugin (@nkuehn)
  • gatsby-transformer-mdx-introspection

🚀 Type: New Feature

  • gatsby-theme-docs, ui-kit

    • #325 feat(theme): add support for specifying new languages for Prism (@emmenko)

    You can now pass a new option availablePrismLanguages to the theme config, which is a list of strings. This is useful in case you need to include Prism languages that are not included by default by prism-react-renderer.

⛑ Type: Refactoring

  • writing-style
    • #323 feat(writing-style): upgrade to vale 2.1.0, don't let vale fail when called from the VSCode plugin (@nkuehn)

2.2.0 (2020-03-25)

🚀 Type: New Feature

  • gatsby-theme-docs, ui-kit

Documentation writers can now reference multiple code examples together in the MDX files. The code examples are grouped together and enables users to switch between them via a dropdown. This is useful when there is a need to provide examples that achieve the same thing in different programming languages.

<MultiCodeExample title="Multilanguage Code Samples">
  <CodeExample path="example.js" highlightLines={[3]} />
  <CodeExample path="example.java"/>
  <CodeExample path="example.console" noPromptLines={[3, 4]} />
</MultiCodeExample>

The code example files are expected to be saved in src/code-examples.

2.1.0 (2020-03-23)

🔮 Type: Chore

  • gatsby-theme-docs
    • #311 fix(theme): remove duplicated source filesystem config (@emmenko)

🚀 Type: New Feature

  • gatsby-theme-docs, gatsby-transformer-code-examples, ui-kit, writing-style
    • #304 feat: code examples provided on graphQL by a transformer plugin (@davifantasia)

🤖 Type: Dependencies

  • broken-link-checker, gatsby-theme-api-docs, gatsby-theme-docs, gatsby-transformer-mdx-introspection, gatsby-transformer-raml-legacy, gatsby-transformer-raml, ramldoc-generator, ui-kit, writing-style
  • gatsby-theme-docs
  • Other

2.0.0 (2020-03-12)

This release introduces some breaking changes, as documented below.

Changes in gatsby-transformer-mdx-introspection

The plugin got an internal re-write and the API changed a bit.

One key area in which it is different is the casing of JSX attributes/tags. This is due to dropping the HTML parsing engine, which automatically converted the case. Now, all components/attributes will use the source casing from the compiled MDX, which is usually Pascal/camelCase.

More detailed information can be found in the package README, as well as the list of supported options.

💥 Type: Breaking Change

  • gatsby-theme-api-docs, gatsby-transformer-mdx-introspection
    • #183 feat(introspection): utilize Babel parser to better parse MDX into component nodes (@jazevedo620)

🚀 Type: New Feature

  • gatsby-theme-api-docs, ramldoc-generator

The new package @commercetools-docs/ramldoc-generator provides an executable to transform any spec-compliant RAML API definition into the (also RAML-compliant) RAML document structure and layout required by the @commercetools-docs/gatsby-transformer-raml plugin.

1.8.1 (2020-02-21)

🐛 Type: Bug

  • gatsby-theme-docs
    • #293 fix(theme): css overrides for search overlay (@emmenko)

1.8.0 (2020-02-19)

🚀 Type: New Feature

  • gatsby-theme-docs
    • #175 feat(theme): restore scroll position of main navigation links, when navigating to a new page (@emmenko)

🤖 Type: Dependencies

  • Other
  • gatsby-theme-api-docs, gatsby-theme-docs

1.7.7 (2020-02-17)

🔮 Type: Chore

  • #281 fix(actions): check out with depth 50 to allow proper canary versions on master branch (@emmenko)
  • #280 fix: publish canary only if lerna detects that packages changed (@emmenko)

⛑ Type: Refactoring

  • gatsby-theme-docs, ui-kit
    • #288 refactor: rendering of code block for syntax highlighting (@emmenko)

1.7.6 (2020-02-07)

⛑ Type: Refactoring

  • gatsby-theme-docs
    • #277 refactor: use more semantic HTML elements for the search crawler (@nkuehn)
  • gatsby-theme-api-docs, gatsby-transformer-raml

🤖 Type: Dependencies

1.7.5 (2020-02-03)

🐛 Type: Bug

  • gatsby-theme-docs
    • c7dd89f fix(theme): ensure css overwrites default one for top menu position (@emmenko)

⛑ Type: Refactoring

  • gatsby-theme-docs

1.7.4 (2020-02-02)

🐛 Type: Bug

  • gatsby-theme-docs
    • #266 fix(theme): to use correct selector to exclude style elements (@emmenko)
    • #265 fix(theme): to patch lobotomized owl selector to ignore style children (@emmenko)
    • #260 fix(theme): sidebar link border color (@emmenko)
  • gatsby-theme-api-docs, gatsby-transformer-raml
  • gatsby-theme-docs, ui-kit
    • #261 fix(theme): use data-link-type instead of aria role attribute (@emmenko)

1.7.3 (2020-01-31)

🔮 Type: Chore

  • gatsby-theme-docs
    • #258 chore(theme): enable custom apps link in top menu (@emmenko)

💅 Type: Enhancement

  • gatsby-theme-docs, ui-kit
    • #253 refactor(theme): to make the link underline style configurable via a prop (@emmenko)

1.7.2 (2020-01-29)

🐛 Type: Bug

  • gatsby-theme-docs, writing-style
    • #247 fix(writing-style): mapping of custom apps casing (@emmenko)

1.7.1 (2020-01-29)

🐛 Type: Bug

  • writing-style
    • #244 fix(writing-style): make Custom Applications capitalized (@emmenko)
  • gatsby-theme-api-docs
  • gatsby-theme-docs, ui-kit
    • #243 fix(theme): disable search input when website has search index disabled (@emmenko)

🔮 Type: Chore

  • #234 chore: ignore .vscode/settings.json, add recommended.code-workspace (@emmenko)

✍️ Type: Documentation

  • gatsby-theme-docs, writing-style
    • #233 docs: improve wording and document some missing things (@emmenko)

⛑ Type: Refactoring

🤖 Type: Dependencies

1.7.0 (2020-01-24)

🐛 Type: Bug

  • gatsby-theme-docs
  • gatsby-theme-api-docs, gatsby-transformer-raml

NOTE that the gatsby-theme-api-docs had some unexpected breaking changes in v1.5.0 (#194), which are now fixed. We recommend to look at the websites/api-docs-smoke-test folder to check and compare the new setup.

🚀 Type: New Feature

⛑ Type: Refactoring

  • gatsby-theme-docs, ui-kit
    • #231 refactor(theme): footer improvements (@emmenko)
    • #227 refactor(theme): footer to contain global links as well (@emmenko)
  • ui-kit
    • #225 refactor(theme): adjust spacings of some elements to improve visual grouping (@emmenko)
  • gatsby-theme-api-docs

🤖 Type: Dependencies

  • broken-link-checker, gatsby-theme-api-docs, gatsby-theme-docs, gatsby-transformer-mdx-introspection, ui-kit
  • Other

1.6.0 (2020-01-17)

🐛 Type: Bug

  • gatsby-theme-docs
    • #213 fix(theme): header layout for small screens (@emmenko)

🚀 Type: New Feature

  • ui-kit
    • #212 feat(theme): add missing spacing for large sizes (@emmenko)

1.5.0 (2020-01-16)

⛑ Type: Refactoring

  • gatsby-theme-docs, ui-kit
    • #179 refactor(theme): to render search results in an overlay, aligned with the page content (@emmenko)
    • #207 refactor(theme): extract logo button component into uikit (@emmenko)
  • gatsby-theme-api-docs
  • gatsby-theme-api-docs, gatsby-transformer-raml

🤖 Type: Dependencies

1.4.1 (2020-01-02)

Happy New Year! 🎉

🤖 Type: Dependencies

1.4.0 (2019-12-27)

🐛 Type: Bug

  • gatsby-theme-docs, ui-kit
    • #176 fix(theme): small layout responsive issues (@emmenko)

⛑ Type: Refactoring

  • gatsby-theme-docs
    • #170 refactor(theme): to change layout to a full (content) page scroll (@emmenko)
    • #173 refactor(theme): to configure svgr plugin for optimized svg files (@emmenko)
    • #172 refactor(theme): to render navigation overlays into a portal (@emmenko)

🤖 Type: Dependencies

  • gatsby-theme-docs
  • broken-link-checker, gatsby-theme-api-docs, gatsby-theme-docs, gatsby-transformer-mdx-introspection
  • Other
  • gatsby-theme-api-docs, gatsby-theme-docs, ui-kit

1.3.2 (2019-12-13)

🐛 Type: Bug

  • ui-kit

1.3.1 (2019-12-13)

🐛 Type: Bug

  • gatsby-theme-docs, ui-kit
    • #160 fix(theme): missing exports, add README to uikit (@emmenko)

1.3.0 (2019-12-13)

We added a new package @commercetools-docs/ui-kit that contains the low-level UI components used to build the documentation website.

If you need to use some of these components, you can use do that directly using the package. Previously some of those components were exposed from the @commercetools-docs/gatsby-theme-docs. For backwards compatibility, all exports of @commercetools-docs/ui-kit are exposed on the @commercetools-docs/gatsby-theme-docs package as well.

🐛 Type: Bug

🚀 Type: New Feature

  • gatsby-theme-api-docs, gatsby-theme-docs, ui-kit
    • #150 feat: extract ui components into a uikit package (@emmenko)
  • broken-link-checker
    • #156 feat(broken-link-checker): warn on insecure links (@emmenko)

⛑ Type: Refactoring

  • gatsby-theme-docs
    • #154 refactor(theme): do not render search bar when excludeFromSearchIndex is true (@emmenko)
  • gatsby-theme-api-docs
    • #155 refactor(theme-api): no hardcoded transformer raml options, instead forward options (@emmenko)

1.2.1 (2019-12-12)

🐛 Type: Bug

  • broken-link-checker

1.2.0 (2019-12-12)

🚀 Type: New Feature

  • gatsby-theme-api-docs, gatsby-theme-docs, gatsby-transformer-mdx-introspection

⛑ Type: Refactoring

  • broken-link-checker
    • #147 refactor(broken-link-checker): read checker options from a config file (@emmenko)

1.1.0 (2019-12-11)

🐛 Type: Bug

  • gatsby-theme-docs
    • #139 fix(theme): match chapter links also for flat page structure (@emmenko)

🚀 Type: New Feature

  • gatsby-theme-docs
    • #132 feat(theme): style definition list elements (@emmenko)

⛑ Type: Refactoring

  • gatsby-theme-docs
    • #140 refactor(theme): to expose CodeBlock component with generic props (no mdx specific) (@emmenko)

1.0.5 (2019-12-10)

🐛 Type: Bug

  • broken-link-checker

1.0.4 (2019-12-10)

⛑ Type: Refactoring

  • broken-link-checker
    • #135 refactor(broken-link-checker): allow to pass excluded-keywords option (@emmenko)

1.0.3 (2019-12-10)

🐛 Type: Bug

  • gatsby-theme-docs
    • #129 fix(theme): SSR style tags messing with nth selectors (@emmenko)

⛑ Type: Refactoring

  • gatsby-theme-docs
    • #133 refactor(theme): to support absolute imports (@emmenko)
  • writing-style
    • #131 refactor(writing-styles): add postinstall script to download vale binary based on OS platform (@emmenko)

1.0.2 (2019-12-09)

🔮 Type: Chore

  • writing-style

1.0.1 (2019-12-06)

The following packages had problems being published in the previous version.

  • @commercetools-docs/gatsby-transformer-mdx-introspection
  • @commercetools-docs/gatsby-transformer-raml-legacy

1.0.0 (2019-12-06)

This is the first "official" release after the initial development. From now we will update the changelog on every new release.

There isn't an official changelog prior to this version.