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

chore(docs): Updating/migrating docs branch and automating docs deployment #6221

Merged
merged 25 commits into from
Sep 2, 2021

Conversation

mmaietta
Copy link
Collaborator

@mmaietta mmaietta commented Sep 2, 2021

  • Migrates docs branch back to master branch within subfolder docs
  • Fixes automation that generates jsdoc2md (now named jsdoc2md2html to describe its explicit behavior).
    • Required adding replace-in-file to purge empty <> tags from the jsdoc assets and markdown2html-pro to migrate autogenerated markdown lists to use HTML since Netlify does some weird formatting when it comes to nested lists
  • Adds schema generation and documentation updates to be automatically generated for Release PRs to keep master and doc site in sync.
  • Added Netlify deploy to be automatically performed on every publish to npm

Mike Maietta added 20 commits August 30, 2021 07:11
Squashed commits:
[aad3a15] testing python version
[441df3f] switching to pipfile
[ecbb333] switching to pipfile
[b513b28] switching to pipfile
[7269dde] adding pip requirements for automating mkdocs
Squashed commits:
[7f47043] moving jsdoc to root tsconfig since ts2jsdoc doesn't follow `extends`
[2944341] adding dmg-license to optional dependency for linux builds
[b58d04b] adding dmg-license to optional dependency for linux builds
…ocs so that they can be parsed to `.md` (+2 squashed commits)

Squashed commits:
[f943733] updating schema
[5ac9ab8] Updating docs
Squashed commits:
[458251b] adding additional Programmatic API pages
# Conflicts:
#	package.json
#	pnpm-lock.yaml
@changeset-bot
Copy link

changeset-bot bot commented Sep 2, 2021

🦋 Changeset detected

Latest commit: 8d19ffb

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@mmaietta mmaietta merged commit 0573808 into master Sep 2, 2021
@mmaietta mmaietta deleted the docs-rev2 branch January 17, 2022 02:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant