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

Update copy service documentation to clarify policies copy prerequisites #204

Merged
merged 1 commit into from Jul 24, 2019

Conversation

miguelsorianod
Copy link
Contributor

No description provided.

@miguelsorianod miguelsorianod merged commit db92a6f into master Jul 24, 2019
@miguelsorianod miguelsorianod deleted the add-custompolicy-info-servicecopy branch July 24, 2019 14:31
@vramosp
Copy link
Collaborator

vramosp commented Jul 24, 2019

The wording seems confusing, I think it'd be more clear if we say something like this is how you copy a service and its custom policies:

  • step 1: copy the custom policies with command x
  • step 2: copy the service with command y
    The point would be to explain that it's 2 different commands and that you need to copy the custom policies first.

@miguelsorianod
Copy link
Contributor Author

miguelsorianod commented Jul 24, 2019

Hi @vramosp,

This PR was already merged.

Take into account that this information has been written in the context of the copy service command so it was described from the service copy centric point of view. The command to copy custom policies is another command and the list of available commands and what they can do is available in the main README.md that references the specific documentation of all of them.

EDIT: Also, you don't really need to copy the custom policies definitions with the command "x", you just have to be sure that they are already in the destination before copying the service(toolbox is not the only method that you can use to set custom policy definitions in a 3scale installation) so that's why the command to do so was not explicitely referenced.

@vramosp
Copy link
Collaborator

vramosp commented Jul 24, 2019

My point is here the user won't know it can be copied as well (with a diff command) and it'd be useful to know. What about just referencing the other command doc at the end, something like:

"Make sure that their respective custom policy definitions already exist in the destination where the service is to be copied before performing the copy. To learn more about copying custom policies check out the documentation (link)"

@miguelsorianod
Copy link
Contributor Author

Seems good to me. I'll open a PR with that new change.

Thank you.

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.

None yet

3 participants