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

[DO NOT MERGE] Documentation update review #172

Closed
wants to merge 44 commits into from
Closed

Conversation

deusebio
Copy link
Contributor

@deusebio deusebio commented Feb 26, 2024

@deusebio deusebio marked this pull request as draft February 26, 2024 08:45
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
deusebio and others added 6 commits February 26, 2024 12:39
Co-authored-by: Andreia Velasco <avgomes42@gmail.com>
Co-authored-by: Andreia Velasco <avgomes42@gmail.com>
Co-authored-by: Andreia Velasco <avgomes42@gmail.com>
Co-authored-by: Andreia Velasco <avgomes42@gmail.com>
Co-authored-by: Andreia Velasco <avgomes42@gmail.com>
Co-authored-by: Andreia Velasco <avgomes42@gmail.com>
Copy link
Contributor

@a-velasco a-velasco left a comment

Choose a reason for hiding this comment

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

LGTM! I really like the new reference tables.

deusebio and others added 22 commits February 26, 2024 14:15
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Co-authored-by: Rob Gibbon <robgibbon@me.com>
Copy link
Contributor

@zmraul zmraul left a comment

Choose a reason for hiding this comment

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

@deusebio @a-velasco fyi related to changing command relate -> integrate.

[~]$ j remove-integration kafka zookeeper                                 
ERROR juju: "remove-integration" is not a juju command. See "juju --help".
                                                                          
Did you mean:                                                             
        remove-relation                                                   

Should we keep it as relate until remove-integration exists?

@deusebio
Copy link
Contributor Author

deusebio commented Feb 27, 2024

I'm not sure there is any plan in Juju to also have remove-integration. I would agree that it would make things more consistent, but if there is no actual plan, we should not constraint one to another. Either way, I suppose we should move away from juju relate as this appears with deprecated warnings in the logs.

Anyhow, I don't mind too much. Up to @a-velasco to make a call such that we keep documentation consistent across DP.

@deusebio
Copy link
Contributor Author

Actually I just found this just spot on.

TLDR remove-relation still makes sense.

integrate is the verb, relation is the noun. So the action/verb is integrating, but whenever we refer to something, it is a "relation", e.g. "Integrating is the action of creating a relation`

@deusebio
Copy link
Contributor Author

superseded by #175

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.

4 participants