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

feat: upgrade project metadata for catalog #33

Merged
merged 6 commits into from
Mar 31, 2020
Merged

feat: upgrade project metadata for catalog #33

merged 6 commits into from
Mar 31, 2020

Conversation

danielgolden
Copy link
Contributor

Upgrade the project meta data to support new catalog commands

The NR1 CLI will soon be updated with commands that enable one to request to have their app added to the catalog. In order to prepare the existing open source NR1 apps for that coming change I've added meta data according to what the catalog commands will be looking for.

  • Add a config.json file to a catalog directory in the repo root, matching this format.
  • Move the /screenshots directory into catalog:
    • Update the screenshot file names (to match this format)
    • Update the screenshot links in the README.md.
  • Add a documentation.md file to a catalog directory in the repo root, matching this format.
  • (Optional) If there's additional documentation referenced in the repo, add a additionalInfo.md file to a catalog directory in the repo root, matching this format.
  • Update the relative paths in documentation.md to be absolute paths
  • Add the new header image to the top of README.md and catalog/documentation.md.
  • Ensure the README.md commands section matches Justin's snippet.
  • Run npm start and let the CLI move the nr1.json
    • Edit that file to make sure the name and description make sense.

Resolves #25

@danielgolden danielgolden added the enhancement New feature or request label Mar 31, 2020
Copy link
Contributor

@jbeveland27 jbeveland27 left a comment

Choose a reason for hiding this comment

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

Left some suggested edits. I think once those are addressed you can merge away 👍

catalog/config.json Outdated Show resolved Hide resolved
catalog/documentation.md Outdated Show resolved Hide resolved
catalog/documentation.md Outdated Show resolved Hide resolved
catalog/documentation.md Outdated Show resolved Hide resolved
catalog/documentation.md Outdated Show resolved Hide resolved
danielgolden and others added 5 commits March 31, 2020 14:00
The old  tagline was a bit too long and would fail validation (max is 30 character).

Co-Authored-By: Justin Eveland <[email protected]>
It would fail validation as the catalog doesn't support images in the documentation.md

Co-Authored-By: Justin Eveland <[email protected]>
Because images don't render in the catalog
@danielgolden danielgolden merged commit 3f2cfc4 into newrelic:master Mar 31, 2020
@danielgolden danielgolden deleted the feat/upgrade-metadata-for-catalog branch March 31, 2020 18:16
devfreddy pushed a commit that referenced this pull request Apr 17, 2020
# [0.4.0](v0.3.2...v0.4.0) (2020-04-17)

### Bug Fixes

* linting issues. ([b054f7b](b054f7b))
* remove another image from the documentation ([de371e3](de371e3))
* remove contributors from documentation ([55b30ea](55b30ea))
* remove image from documentation.md ([335fa96](335fa96))
* remove images from catalog documentation ([07f3254](07f3254))
* Styles for when there are more than 4 rows ([7f7678b](7f7678b)), closes [#26](https://github.com/newrelic/issues/26)
* upgrade eslint closes newrelic/nr1-customer-journey[#28](#28) ([2e0802d](2e0802d))

### Features

* remove moment, add nr1-community, closes newrelic/nr1-customer-journey[#24](#24) ([ccd0421](ccd0421))
* upgrade project metadata for catalog ([25388bb](25388bb)), closes [#25](https://github.com/newrelic/issues/25)
* upgrade project metadata for catalog ([#33](#33)) ([3f2cfc4](3f2cfc4)), closes [#25](https://github.com/newrelic/issues/25)
@devfreddy
Copy link
Contributor

🎉 This PR is included in version 0.4.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Upgrade the project meta data to support new catalog commands
3 participants