Skip to content
This repository has been archived by the owner on Nov 15, 2022. It is now read-only.

Rename objects #427

Closed
cdrage opened this issue Nov 6, 2017 · 8 comments
Closed

Rename objects #427

cdrage opened this issue Nov 6, 2017 · 8 comments

Comments

@cdrage
Copy link
Collaborator

cdrage commented Nov 6, 2017

Within file-reference.md we have different names for different objects.

For example: http://kedgeproject.org/file-reference/#containerspec

We have containerSpec, service and then.... routeObject.

Names should be consistent.

Either:

containerSpec, serviceSpec, routeSpec

or

containerObject, serviceObject, routeObject

👍 for Object.

@cdrage
Copy link
Collaborator Author

cdrage commented Nov 6, 2017

Thoughts @kadel @pradeepto

@pradeepto
Copy link
Member

Good catch. We should be consistent with our object naming. This is definitely an UX issue.

@kadel
Copy link
Member

kadel commented Nov 7, 2017

There is a difference between routeObject and routeSpec

routeObject refers to Kedge struct that includes OpenShift's routeSpec and objectMeta
https://github.com/kedgeproject/kedge/blob/master/pkg/spec/types.go#L78

@cdrage
Copy link
Collaborator Author

cdrage commented Nov 7, 2017

@kadel Problem is that most people won't be looking at the code-names, but rather the documentation names. Could we refer to it as a routeSpecObject instead within the documentation?

Are you good with the other parts being renamed (containerObject, serviceObject, etc..)

@kadel
Copy link
Member

kadel commented Nov 7, 2017

We should distinguish between what is referring to our RouteSpecMod and what is referring upstream RouteSpec. We have to careful and not to interchange them. It can have whatever name but we just can't interchange them.

@cdrage
Copy link
Collaborator Author

cdrage commented Nov 7, 2017

Hmm. so in the docs, let's go with routeSpecObject? @kadel

@kadel
Copy link
Member

kadel commented Nov 7, 2017

You are talking about what will be in the sidebar in Objects section, right?

I would actually go with just 'route' and 'ingress'

@cdrage cdrage added this to the 0.5.0 milestone Nov 8, 2017
@cdrage
Copy link
Collaborator Author

cdrage commented Nov 16, 2017

PR here: #429

@kadel kadel closed this as completed Nov 22, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants