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

Deprecate most package metadata #1621

Closed
jpmckinney opened this issue Jun 7, 2023 · 3 comments · Fixed by #1640
Closed

Deprecate most package metadata #1621

jpmckinney opened this issue Jun 7, 2023 · 3 comments · Fixed by #1640
Assignees
Labels
Focus - Packages Relating to release packages and record packages
Milestone

Comments

@jpmckinney
Copy link
Member

jpmckinney commented Jun 7, 2023

While #1084 and #426 are postponed, in 1.2, we can still remove validation properties from package metadata (required, uniqueItems, etc.) and deprecate fields like uri, publisher (already at release level), publishedDate, license, publicationPolicy.

In other words, only version, extensions and releases / records are not deprecated.

We can also revert the links field from #1422.

There was also a comment in #1084 about re-organizing the content about packages: #1084 (comment)

Note that when we review the documentation, we can probably also close

@jpmckinney jpmckinney added the Schema: Fields Relating to adding or deprecating fields in the JSON Schema label Jun 7, 2023
@jpmckinney jpmckinney added this to the 1.2.0 milestone Jun 7, 2023
@jpmckinney jpmckinney added Focus - Packages Relating to release packages and record packages and removed Schema: Fields Relating to adding or deprecating fields in the JSON Schema labels Jun 8, 2023
@jpmckinney
Copy link
Member Author

As part of this, we can remove the package schema from the extension template.

@duncandewhurst
Copy link
Contributor

While #1084 and #426 are postponed, in 1.2, we can still remove validation properties from package metadata (required, uniqueItems, etc.) and deprecate fields like uri, publisher (already at release level), publishedDate, license, publicationPolicy.

In other words, only version, extensions and releases / records are not deprecated.

We can also revert the links field from #1422.

I've made the above schema changes in #1640

There was also a comment in #1084 about re-organizing the content about packages: #1084 (comment)

The comment is about reducing the length of the Reference menu, which has the following items related to releases, records and packaging (I'm assuming that we won't touch the items from Merging onwards as part of this issue):

  • Release Reference
  • Release Schema
  • Release Package Schema
  • Record Reference
  • Record Package Schema

In #716, I proposed adding a Record Schema page, which would increase the length of the Reference menu. I still think that we should do that. To reduce the number of packaging-related items, we could put them under a Packaging item. Given that the package schemas are small, I don't think there's much value in putting the schema browser and reference documentation on separate pages so the packaging item could have two sub-pages:

  • Release Reference
  • Release Schema
  • Record Reference
  • Record Schema
  • Packaging
    • Release Package Reference (Schema browser and content from the Package Metadata section of the release reference)
    • Record Package Reference (Schema browser and content from the Package metadata section of the record reference)

If a bulk data format is added in 1.3.0/2.0.0, those pages could then be moved under an 'API format' sub-page:

  • Release Reference
  • Release Schema
  • Record Reference
  • Record Schema
  • Packaging
    • API Format
      • Release Package Reference
      • Record Package Reference
    • Bulk Data Format

@jpmckinney does that sound good?

Note that when we review the documentation, we can probably also close

@jpmckinney since the proposals in that issue predate the improved Primer and Guidance documentation, could you give an idea of which of your proposals still need to be addressed?

Done in #1640 (uncollapsed publisher per #1551 (comment))

@jpmckinney
Copy link
Member Author

@jpmckinney does that sound good?

Sounds good!

@jpmckinney since the proposals in that issue predate the improved Primer and Guidance documentation, could you give an idea of which of your proposals still need to be addressed?

I can't find any :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Focus - Packages Relating to release packages and record packages
Projects
Status: Done
2 participants