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

rebrand nf-validation to nf-schema #1

Merged
merged 11 commits into from
Apr 11, 2024
Merged

rebrand nf-validation to nf-schema #1

merged 11 commits into from
Apr 11, 2024

Conversation

nvnieuwk
Copy link
Collaborator

@nvnieuwk nvnieuwk commented Mar 20, 2024

This PR changes all nf-validation mentions to nf-schema (with exception of the changelog)

@nvnieuwk nvnieuwk requested review from ewels and mirpedrol March 20, 2024 12:42
Copy link
Collaborator

@awgymer awgymer left a comment

Choose a reason for hiding this comment

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

Looks good but seems several things got mangled - mostly URLs.

Also URLs that point to commits/blob ids are the same. I think that is right but might be worth double-checking they exist!

docs/nextflow_schema/nextflow_schema_examples.md Outdated Show resolved Hide resolved
docs/nextflow_schema/create_schema.md Outdated Show resolved Hide resolved
docs/nextflow_schema/nextflow_schema_examples.md Outdated Show resolved Hide resolved
docs/nextflow_schema/nextflow_schema_examples.md Outdated Show resolved Hide resolved
docs/nextflow_schema/sample_sheet_schema_specification.md Outdated Show resolved Hide resolved
docs/nextflow_schema/sample_sheet_schema_specification.md Outdated Show resolved Hide resolved
docs/schema_input.json Outdated Show resolved Hide resolved
docs/images/nf-validation.svg Outdated Show resolved Hide resolved
@nvnieuwk nvnieuwk requested a review from awgymer March 20, 2024 13:10
Copy link
Collaborator

@awgymer awgymer left a comment

Choose a reason for hiding this comment

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

Just one little issue still I think

docs/nextflow_schema/sample_sheet_schema_specification.md Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

Needs replacing and renaming I think?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yep, I'm not sure how to make this logo (@mirpedrol you made it, right?)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, I will push a new image with the new name. We should also think of a new logo later.

Copy link
Collaborator

Choose a reason for hiding this comment

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

done! The check mark doesn't make a lot of sense now, do you have better ideas?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Maybe the icon without the check mark? It kinda looks like schemafile

docs/index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, I will push a new image with the new name. We should also think of a new logo later.

docs/nextflow_schema/sample_sheet_schema_specification.md Outdated Show resolved Hide resolved
examples/fromSamplesheetOrder/pipeline/nextflow.config Outdated Show resolved Hide resolved
@nvnieuwk nvnieuwk requested a review from awgymer April 9, 2024 13:42
@@ -19,7 +19,7 @@ jobs:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- name: Obtain version from MANIFEST.MF
run: echo "plugin_version=$(grep "Plugin-Version" plugins/nf-validation/src/resources/META-INF/MANIFEST.MF | awk '{print $2}' | awk -F '.' '{print $1"."$2}')" >> $GITHUB_ENV
run: echo "plugin_version=$(grep "Plugin-Version" plugins/nf-schema/resources/META-INF/MANIFEST.MF | awk '{print $2}' | awk -F '.' '{print $1"."$2}')" >> $GITHUB_ENV

Choose a reason for hiding this comment

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

no src/?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good spot!!!

Choose a reason for hiding this comment

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

the viewbox is too small, the a is out of it

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Weird, it's fine for me 😕

@@ -9,12 +9,12 @@ hide:
You can see an example JSON Schema for a Nextflow pipeline `nextflow_schema.json` file below.

This file was generated from the nf-core pipeline template, using `nf-core create`.
It is used as a test fixture in the nf-validation package [here](https://github.com/nextflow-io/nf-validation/blob/master/plugins/nf-validation/src/testResources/nextflow_schema.json).
It is used as a test fixture in the nf-schema package [here](https://github.com/nextflow-io/nf-schema/master/plugins/nf-schema/resources/nextflow_schema.json).

Choose a reason for hiding this comment

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

sure about that url?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ah missed another one 😁 Thanks!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Although no it's the correct one. (It works when I view it using mkdocs serve)

Choose a reason for hiding this comment

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

All look ok to me for this PR, except this line, but if you say it's ok, it's a ✔️ from me

Copy link

@maxulysse maxulysse left a comment

Choose a reason for hiding this comment

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

LGTM

@nvnieuwk
Copy link
Collaborator Author

@awgymer can you also approve this since you requested changes?

Copy link
Collaborator

@awgymer awgymer left a comment

Choose a reason for hiding this comment

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

Changes mostly look good to me.
Few small clarifications needed before merge but I've approved anyway.

README.md Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

The font looks off here (looks like a serif font of some form) but not sure if just a github display issue?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah I'm not sure what's going on there... The png looks fine though. @mirpedrol any ideas?

docs/index.md Show resolved Hide resolved
docs/migration_guide.md Show resolved Hide resolved
docs/nextflow_schema/create_schema.md Show resolved Hide resolved
@nvnieuwk
Copy link
Collaborator Author

Okay I'll merge this now, we can still open another PR if more small issues are found/resolved

@nvnieuwk nvnieuwk merged commit 1a14113 into master Apr 11, 2024
6 checks passed
@nvnieuwk nvnieuwk deleted the rebrand-to-nf-schema branch April 11, 2024 14:15
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