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

Mount migration tool #2544

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Mount migration tool #2544

wants to merge 5 commits into from

Conversation

dannymidnight
Copy link
Contributor

I had a think about https://github.com/buildkite/buildkite/pull/14388 and I thought perhaps our docs is good place for hosting the migration tool.

This PR renders a hosted version of the https://github.com/buildkite/migration under /docs/migrate.

It's a little hacky using a submodule, since there's some dependencies required, but it also seems totally fine as an interim solution for giving this tool a home. Long term, I wouldn't expect the API to live in the docs.

I replicated all the markup into docs primarily to control the form endpoint, but it now gives us full control over the styling etc if we want to play around with this.

Screenshot 2023-11-02 at 12 29 18 pm

Thoughts @MelissaKaulfuss @mbelton-buildkite?!

Worth noting that for this PR the static preview will render the page but the transform won't work since that requires a backend.

@dannymidnight dannymidnight requested a review from a team as a code owner November 2, 2023 01:33
Base automatically changed from ruby-3.2.2 to main November 2, 2023 01:33
@buildkite-docs-bot
Copy link
Collaborator

Preview URL: https://2544--bk-docs-preview.netlify.app

@dannymidnight
Copy link
Contributor Author

Worth noting that for this PR the static preview will render the page but the transform won't work since that requires a backend.

I tell a lie. The preview won't render this route since it's not currently linked anywhere and the static site is generated from being crawled.

@mbelton-buildkite
Copy link
Contributor

I think adding this to the docs is a great idea. Thoughts for making it real:

  • Add it as a page at /pipelines/translator with title "Pipeline translator." We might want to rethink those, but seems like a good place to start. Key thing for me is that it should display in the nav alongside the relevant content.
  • Slap a "Beta" label on the page to give us some wiggle room.
  • Can we add some some content to the top of the page to explain what someone is looking at? Like somewhere to add normal Markdown or HTML. It would be good to update the design, but adding a disclaimer about what it is and what it can do at the top is probably a good enough place to start.

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