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.

Sign up for GitHub

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

Jump to bottom

Metadata standardization #3890

Closed
4 tasks done
plague006 opened this issue May 3, 2016 · 12 comments
Closed
4 tasks done

Metadata standardization #3890

plague006 opened this issue May 3, 2016 · 12 comments
Labels
Discussion needed

Comments

@plague006
Copy link
Contributor

plague006 commented May 3, 2016 •
edited

@politas @Dazpoet @techman83 @dbent @Olympic1

With us moving towards a real mirrorkan (KSP-CKAN/CKAN#1682) and having file hashes in the metadata (KSP-CKAN/CKAN#1703) it's time to stop letting PRs into CKAN-meta unless it can't be avoided.

To that end I've scraped the metadata for all the identifiers we currently have and where .netkans didn't previously exist I have opened #3892 and #3893 to create either a .netkan if the mod meets certain criteria or a .frozen for mods that don't.

Speaking for myself in the past things have been a little unclear and inconsistent in how extensions were applied and when .netkans were deleted. I'd love for that to change moving forward.

.frozen should be applied to any former .netkan that no longer passes the indexer's test and can't be made to work. This will also include "placeholder" files to represent identifiers that are claimed. .netkan files should no longer be deleted in any case other than when we are de-indexing a mod fully and completely (no leftover references to the identifier anywhere in the metadata).

A little to-do list mostly to remind myself but I'd be ecstatic if someone else does it before me:

  • Add/modify PR template in ckan-meta to make submitters aware that they should PR to netkan.
  • Add/modify issue template in ckan-meta to redirect all issues to this repo.
  • Modify "Adding mod" wiki entry to reflect new metadata submission process.
  • Check to see if CONTRIBUTING/README files need updates (and update if applicable).
@dbent
Copy link
Member

dbent commented May 3, 2016

.ckangenerator could just be .netkan, there's not much need to distinguish them.

@plague006
Copy link
Contributor Author

Yeah I don't know why I'd forgotten that the plan was to just PR the .netkan and have the indexer inflate the CKAN. I had in mind that we would still PR netkan-generated .ckan files. Will edit OP.

plague006 added a commit that referenced this issue May 3, 2016
@plague006
Add placeholder files based on claimed identifiers. Part of #3890
ce46cd5
plague006 added a commit that referenced this issue May 3, 2016
@plague006
Add netkans based on ckan-meta .ckans. Part of #3890
66fbb1f
This was referenced May 3, 2016
Merged
Merged
@dbent
Copy link
Member

dbent commented May 3, 2016

LGTM

This was referenced May 3, 2016
Merged
Merged
@plague006
Copy link
Contributor Author

plague006 commented May 4, 2016 •
edited

For the sake of completeness I'm also going to create files for virtual modules. This will also allow us a method to quickly and easily test to see if a mod is trying to take an occupied namespace (KSP-CKAN/xKAN-meta_testing#8). Just 1 less thing that can go wrong.

@techman83
Copy link
Member

LGTM. The indexer attempts to inflate all files with the NetKAN extension in the NetKAN directory. Anything else gets ignored. So frozen is more of a convention than a hard requirement (a sane one, though I'd be happy with .doge :P).

Moving away from hand crafting metadata is a GoodThing™ 👍

@plague006
Copy link
Contributor Author

Rewrote a bunch of the "Adding a mod" wiki entry. Would appreciate someone taking a look over it and editing as required. https://github.com/KSP-CKAN/CKAN/wiki/Adding-a-mod-to-the-CKAN

@politas
Copy link
Member

politas commented May 7, 2016

Replacing "s with `s - can you explain your thinking there? Why not simply add the backticks to make it code formatted, leaving the quotes, which are a literal part of the file contents?

@plague006
Copy link
Contributor Author

In the wiki? Dunno, formatting might be a little messy since I used a plain text editor while working on it.

@politas
Copy link
Member

politas commented May 7, 2016 •
edited

It wasn't deliberate, then? All the in-line mentions of a codeword, like "depends" or "install" have been turned into in-line code depends or install. If you didn't do that on purpose, you might want to take a look at your editor settings.

@plague006
Copy link
Contributor Author

plague006 commented May 8, 2016 •
edited

Oh for fields? Yes I changed those to code so that it's clear that they're code.

@politas
Copy link
Member

politas commented May 8, 2016

Then, give that the quotes are part of the code, would it be better to have, for instance, "depends" so that the literal file entry is maintained?

@politas politas mentioned this issue May 8, 2016
Merged
plague006 added a commit that referenced this issue May 13, 2016
@plague006
Add placeholder files based on claimed identifiers. (#3892)
6a859fb 
* Add placeholder files based on claimed identifiers. Part of #3890

* Add virtual mods as .frozen files

* Add ActiveStruts
techman83 pushed a commit that referenced this issue May 17, 2016
@plague006 @techman83
Add netkans based on ckan-meta .ckans. (#3893)
a62c6e3 
* Add netkans based on ckan-meta .ckans. Part of #3890

* Update KerBalloons

* Update KerbalStats

* Update StationScience

* Strip Netkan generated lines (#3944)

Removes all the "x_generated_by" : "netkan" and "download_size" lines

* Strip Netkan generated lines (#3944)

Removes all the "x_generated_by" : "netkan" and "download_size" lines (reverted from commit 94b788d)

* Remove ActiveStruts (Marce mod)

* Remove Netkan-generated lines (#3957)

Now with excess comma removal!

* Replace Frozen KerbalKrashSystem (#3978)

* Bump spec

* Change filename to identifier

* Remove RN-SalyutStations-SoyuzFerries

* Remove known broken/dead downloads

* Remove AstronomersPack

* Dead link

* Restore HeatControl

* Update precisenode

* Update toolbar
@techman83
Copy link
Member

This is all looking done. Anything holding us back from closing this?

@techman83 techman83 mentioned this issue May 18, 2016
Closed
12 tasks
@Ezriilc Ezriilc mentioned this issue Jun 22, 2016
Merged
This was referenced Jun 27, 2016
Closed
Closed
@NathanKell NathanKell mentioned this issue Jul 5, 2016
Closed
@Blu3wolf Blu3wolf mentioned this issue Jul 6, 2016
Merged
@thewebbooth thewebbooth mentioned this issue Sep 11, 2016
Closed
Dazpoet added a commit that referenced this issue Oct 28, 2016
@Dazpoet
Update ModularFuelTanks.netkan
2117a87 
User GeekArt came onto irc asking for this to be updated. Based on #3890 I assume this is how we're supposed to do it now?

I think I poked the right parameters :)
@Dazpoet Dazpoet mentioned this issue Oct 28, 2016
Merged
politas pushed a commit that referenced this issue Oct 28, 2016
@Dazpoet @politas
Update ModularFuelTanks.netkan (#4845)
45d6b53 
User GeekArt came onto irc asking for this to be updated. Based on #3890 I assume this is how we're supposed to do it now?

I think I poked the right parameters :)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Discussion needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@dbent @politas @techman83 @plague006