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

Rename oasis-indexer to nexus #467

Merged
merged 11 commits into from Jun 28, 2023
Merged

Rename oasis-indexer to nexus #467

merged 11 commits into from Jun 28, 2023

Conversation

mitjat
Copy link
Collaborator

@mitjat mitjat commented Jun 27, 2023

Marketing directive.

Renames/changes:

  • all references to github.com paths (notably, Go imports)
  • the structure of docker images; all oasis-indexer path components are renamed nexus, including mount points and the name of the main binary
    • These changes are substantial, but perhaps counterintuitively, it is easier to change most occurrences of oasis-indexer with nexus, rather than being very selective and changing only some, e.g. keeping oasis-indexer in most places but renaming only the binary (a "requirement"). It will hopefully also reduce confusion for readers to mostly have a single name used consistently.
  • most usages of "indexer" everywhere in the codebase
  • adds an intro paragraph to top-level README

Does NOT rename/change:

  • The DB usernames and dbnames in our various docker setups. Many contain "indexer". While perfectly doable to rename, it's brittle. We can do it later if we want.
  • The docker image repo, or the references to it. That one remains as oasislabs/oasis-indexer (that's Labs!)

Command:
find -not -path '*/.git/*' -not -path './cache/*' -type f | xargs sed -i -E 's!github.com/(oasisprotocol|oasislabs)/oasis-indexer!github.com/oasisprotocol/nexus!g'
@mitjat mitjat force-pushed the mitjat/rename-indexer-to-nexus branch from 0e24212 to 9267e93 Compare June 28, 2023 00:45
@mitjat mitjat changed the title (WIP) Rename oasis-indexer to nexus Rename oasis-indexer to nexus Jun 28, 2023
Copy link
Member

@tjanez tjanez left a comment

Choose a reason for hiding this comment

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

Great work, thanks!

@@ -46,7 +46,7 @@ jobs:
run: go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.12
- name: Build Go
run: |
make oasis-indexer
make nexus
Copy link
Collaborator

Choose a reason for hiding this comment

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

(no-op) I'd prefer oasis-nexus over nexus since we refer to it as Oasis Nexus in the docs. It'd also be consistent with Oasis Explorer and how most of our services historically were prefixed with oasis-. But since this rename is requested by marketing it's not up to us so I'll just lodge my objection here for posterity and we can leave as-is.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I actually prefer nexus here because it's more of a token/identifier, and in that role, we never use oasis-nexus (with a hyphen); for consistency and simplicity, I like that we always have one or the other.
We mostly use "Oasis Nexus" in external docs when there is little external context and we want to additional qualify the name. We also use just "Nexus" in externally facing docs plenty of time.

@mitjat mitjat merged commit 92be54e into main Jun 28, 2023
6 checks passed
@mitjat mitjat deleted the mitjat/rename-indexer-to-nexus branch June 28, 2023 20:38
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