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

Adjusting outline-docs package so projects can use them #381

Merged
merged 3 commits into from
May 22, 2023

Conversation

tekante
Copy link
Member

@tekante tekante commented Apr 29, 2023

Description

Modify the build to actually include the documentation files, correct README, and change the template for spinning up new projects to automatically include them in the storybook instance. This will result in the Documentation folder with welcome and guides one sees on https://outline.phase2tech.com/ to be present in the project's Storybook instance as well.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • Manually on local instance
  • Visual Testing
  • Automated Testing
  • Accessibility Testing

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Also changes the template for spinning up new projects
@changeset-bot
Copy link

changeset-bot bot commented Apr 29, 2023

⚠️ No Changeset found

Latest commit: 0e82fc7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

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

Click here to learn what changesets are, and how to add one.

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

@tekante tekante requested a review from himerus April 29, 2023 23:45
@netlify
Copy link

netlify bot commented Apr 29, 2023

Deploy Preview for outlinejs ready!

Name Link
🔨 Latest commit 0e82fc7
🔍 Latest deploy log https://app.netlify.com/sites/outlinejs/deploys/644dad6ac599550008f22317
😎 Deploy Preview https://deploy-preview-381--outlinejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@tekante tekante self-assigned this May 1, 2023
@@ -1,7 +1,7 @@
{
"name": "@phase2/outline-templates",
"description": "The Outline Starter Templates",
"version": "0.0.33",
"version": "0.0.34",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I be changing these or is this automatically managed on merging based on the conventional commit messages?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, because outline-templates had content updated (the package.json in the default directory, this should be bumped an a new release created for the template.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I need to document (and automate) the Changeset releases to make this easier to understand.

@himerus
Copy link
Contributor

himerus commented May 22, 2023

For some reason this is failing at the moment as https://yarnpkg.com/package/@phase2/outline-templates is out of sync with https://www.npmjs.com/package/@phase2/outline-templates

Going to merge and move on to see if this somehow clears up. A new release will need to be triggered with these updates anyway.

@himerus himerus merged commit 6b51c6f into next May 22, 2023
@himerus himerus deleted the feature/docs-in-project-storybook branch May 22, 2023 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants