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.

Sign up for GitHub

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

Jump to bottom

refactor: rename go-ipfs to kubo #1185

Merged
merged 19 commits into from
Jul 21, 2022
Merged

refactor: rename go-ipfs to kubo #1185

merged 19 commits into from
Jul 21, 2022

Conversation

johnnymatthews
Copy link
Contributor

@johnnymatthews johnnymatthews commented Jun 23, 2022 •
edited by Jorropo
Loading

In preparation for Go-IPFS' big remove to Kubo, this PR changes go-ipfs to kubo and Go-IPFS to `Kubo.

TODO / logistics

This PR depends on:

This PR should merged before kubo 0.14 release is tagged at https://github.com/ipfs/kubo/releases – that way we will see if automation responsible for generating RPC and CLI reference was migrated correctly No, too many dependencies on having real release (and kubo has none), we need 0.14 first.

@lidel lidel self-assigned this Jun 23, 2022
@lidel
Add Kubo to glossary
baa7c56 
and fix outdated statements along the way
@lidel
Copy link
Member

lidel commented Jun 23, 2022

Thank you, we will merge this AFTER kubo 0.14 is released 👍

lidel added 3 commits June 26, 2022 22:50
@lidel
Separate Kubo RPC and CLI reference
e36402e 
Old version suggested Kubo RPC is "IPFS RPC".

This refactor moves Kubo RPC and CLI under `/reference/kubo/`
while ensuring we don't break existing websites linking to specific RPC
command docs, and orchestration responsible for updating docs continues
working under the new paths.

A placeholder for HTTP Gateway reference is added, as we want people to
default to Gateway API and use implementation-specific RPC only when
generic Gateway interface is not enough.
@lidel
Merge branch 'main' into feat/renaming-go-ipfs
81d18eb
@lidel
fix: http/api#api-v0-foo → kubo/rpc#api-v0
b4139b9 
Vuepress was ignoring inlinded JS outside dev mode. This refactors the
way advanced redirect is done to always work.
@ipfs ipfs deleted a comment from filecorgi Jun 26, 2022
@lidel
Copy link
Member

lidel commented Jun 26, 2022 •
edited
Loading

@johnnymatthews @BigLep @aschmahmann @2color (FYI)

I've pushed a refactor (moving around existing content) of https://docs.ipfs.io/reference/ page.
This was necessary to clearly separate Kubo APIs (RPC, CLI) from generic one (HTTP Gateway), and create space for more implementations.

Before After
2022-06-27_01-02 2022-06-27_00-19

This refactor covers all edge cases I was aware of, includes updating existing API reference generators for both CLI and RPC, adding redirects so old links continue to work, and updating references on pages that link to them:

  • old /reference/cli/ is now /reference/kubo/cli/
  • old /reference/http/api/ is now /reference/kubo/rpc/
  • new /reference/http/api/ is an intermediate landing which has links to /reference/http/gateway/ and /reference/kubo/rpc/ – most users won't see it, but we need it for backward-compatibility, so if someone uses old URL we can signal that RPC is not everything.
    • I've added some additional magic to ensure pages linking to /reference/http/api/#api-v0-foo will get redirected to /reference/kubo/rpc/#api-v0-foo – this way we don't have any UX regression around RPC docs
  • Existing "IPFS in JS" and "IPFS in Go" pages are not the best, but improving them is out of scope of this PR.

@lidel lidel marked this pull request as ready for review June 26, 2022 22:33
@lidel
refactor: .github/workflows/update-on-new-ipfs-tag
29454da 
Renamed everything to kubo.
(curl was not following redirects, so it would fail anyway)
@BigLep
Copy link
Contributor

BigLep commented Jun 30, 2022

2022-06-30 conversation: we're ideally going to merge this before the 0.14-rc1 release.

@BigLep BigLep mentioned this pull request Jun 30, 2022
Closed
68 tasks
@lidel lidel mentioned this pull request Jul 1, 2022
Closed
11 tasks
@lidel lidel changed the title Renames go-ipfs to kubo. refactor: rename go-ipfs to kubo Jul 1, 2022
@lidel
Copy link
Member

lidel commented Jul 6, 2022 •
edited
Loading

This is blocked until we have kubo 0.14.0 (final stable release)

This was referenced Jul 8, 2022
Closed
Merged
This was referenced Jul 20, 2022
Closed
Merged
lidel and others added 2 commits July 20, 2022 23:14
@lidel
docs: reference/http/gateway/#api
f9c8ca7 
Replaces placeholder with basic information about the API
and points at follow-up resources (how-tos, specs)
@Jorropo
chore: bump kubo to v0.14 in http-api-docs
859cbfb
@Jorropo
Copy link
Contributor

Jorropo commented Jul 21, 2022 •
edited
Loading

I've pushed the todos, I folowed the README.md but I'm not sure I was correct, could someone review pls ?

(I think e18258e is wrong but I don't really know what to do instead)

@lidel lidel force-pushed the feat/renaming-go-ipfs branch from e18258e to 96feb4b Compare July 21, 2022 10:37
@lidel lidel force-pushed the feat/renaming-go-ipfs branch from 96feb4b to 593dbc5 Compare July 21, 2022 10:43
@lidel
Copy link
Member

lidel commented Jul 21, 2022

Thank you @Jorropo! I replaced e18258e with 593dbc5 (docs got moved around, but after we merge this, it will be automated for the next release)

@filecorgi
Copy link
Contributor

  • Image optimization came back clean!
  • Vuepress build was successful!

@lidel
Copy link
Member

lidel commented Jul 21, 2022

Merging – I will refine HTTP Gateway page in follow-up PR and ping folks for review (this PR is too big for humans).

@lidel lidel merged commit ca6603d into main Jul 21, 2022
@lidel lidel deleted the feat/renaming-go-ipfs branch July 21, 2022 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lidel lidel lidel approved these changes

Assignees

@lidel lidel

Labels
None yet
Projects
No open projects
IPFS Shipyard Team
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@johnnymatthews @lidel @BigLep @Jorropo @filecorgi