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

Q: branch vs folder? #37

Closed
bph opened this issue Apr 22, 2024 · 1 comment · Fixed by #36
Closed

Q: branch vs folder? #37

bph opened this issue Apr 22, 2024 · 1 comment · Fixed by #36
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@bph
Copy link
Collaborator

bph commented Apr 22, 2024

In Contributing.md it says:

For example, if you want to load a content-export.xml file and your branch is called woocommerce-subscriptions, then your PR must contain a

A blueprints/woocommerce-subscriptions/blueprint.json file
A blueprints/woocommerce-subscription/content-export.xml file the Blueprint should reference as follows:
{
	"steps": [
		{
			"step": "importWxr",
			"file": {
				"resource": "url",
				"url": "https://raw.githubusercontent.com/adamziel/blueprints/woocommerce-subscriptions/blueprints/woocommerce-subscriptions/content-export.xml"
			}
		}
	]
}

This makes it seem that the branch name and the folder name need to be the same. That doesn't seem to be necessarily the case. If i am correct I would suggest to change the example

That the example branch is called something different than the folder, like /woo-subsriptions/
and the url: is modified to https://raw.githubusercontent.com/adamziel/blueprints/woo-subsriptions/blueprints/woocommerce-subscriptions/content-export.xml

And add another sentence in
The folder of your files would be /woocommerce-subscription

It would read like this

For example, if you want to load a content-export.xml file,
you create a new folder in the blueprints directory, /woocommerce-subscription (the name should correpong to the name of the blueprint and must hold two files.
A blueprints/woocommerce-subscriptions/blueprint.json file
A blueprints/woocommerce-subscription/content-export.xml file
Your branch you named /woo-subscription/ (this name is up to you)

Then the Blueprint should reference as follows:

	"steps": [
		{
			"step": "importWxr",
			"file": {
				"resource": "url",
				"url": "https://raw.githubusercontent.com/adamziel/blueprints/woo-subscriptions/blueprints/woocommerce-subscriptions/content-export.xml"
			}
		}
	]
}```
@adamziel
Copy link
Contributor

This makes it seem that the branch name and the folder name need to be the same. That doesn't seem to be necessarily the case. If i am correct I would suggest to change the example

You are correct Birgit, good spot 👍 the example could use brushing up.

@bph bph self-assigned this Apr 23, 2024
@bph bph added the documentation Improvements or additions to documentation label Apr 23, 2024
bph added a commit that referenced this issue Apr 23, 2024
@bph bph linked a pull request Apr 23, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants