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 repository to dart-lang/website #5221

Open
4 tasks
parlough opened this issue Sep 23, 2023 · 10 comments
Open
4 tasks

Rename repository to dart-lang/website #5221

parlough opened this issue Sep 23, 2023 · 10 comments
Assignees
Labels
co.proposal Community ask to change an approach or process for docs.Dart.dev e2-days Can complete in < 5 days of normal, not dedicated, work infra.structure Relates to the tools that create dart.dev p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. review.pm Awaiting Product Manager Review

Comments

@parlough
Copy link
Member

parlough commented Sep 23, 2023

Discussion

Problem:

Lack of discoverability:

  • site-www is not a common repository name for open-source website repositories, so it can't be guessed.
  • (Most?) browsers now hide www if it is chosen, so younger developers may not be familiar with the subdomain at all. The world wide web is a term I rarely hear these days.
  • The term "website" is twice as popular as just "site" on Google Trends.
  • site-www is not cleanly translatable compared to just website.

Inconsistency:

  • For workflows and context switching, it's nice to have a consistent name, but this repository name isn't consistent with any other website you may work on.

Possibilities (and discussion):

To improve repository discoverability and consistency, we can rename the repository. The following is a collection of potential options, a little discussion about each, and some examples.

I personally like dart-lang/website to be consistent with the Flutter and Go sites, which are the most likely to share contributors. It's also the most flexible allowing us to change domain names (or to a sub-domain) without updating the repository name. It's generally easier to type as well, with one less character and no punctuation.

Suggested fix with steps

  • Rename repository to dart-lang/website, dart-lang/dart.dev, or whatever is chosen. GitHub redirects links to the old destination to the new one automatically.
  • Update text and link references to repository across various Dart and Flutter repos/docs
  • Update any internal repo tracking/tooling for repository rename
  • Slowly update other old links as came across (redirect will cover those cases)

These steps assume a new repository named site-www will not be made, as otherwise the redirect will be lost.

I'm not aware of internal tooling behind repositories, so there may be more steps than this. Feel free to add to this list, thanks!

@parlough parlough added infra.structure Relates to the tools that create dart.dev p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. e2-days Can complete in < 5 days of normal, not dedicated, work co.proposal Community ask to change an approach or process for docs.Dart.dev labels Sep 23, 2023
@shaikahmadnawaz
Copy link
Contributor

Hello @parlough, can I work on this issue?

@parlough
Copy link
Member Author

Hello @parlough, can I work on this issue?

Hey @shaikahmadnawaz! Thanks for the offer.

However, this particular proposal still needs to be reviewed/approved and would need to be at least initially worked on by an admin in the dart-lang GitHub organization.

If you have feedback on a better name, that would of course be welcome :)

@shaikahmadnawaz
Copy link
Contributor

Hello @parlough, can I work on this issue?

Hey @shaikahmadnawaz! Thanks for the offer.

However, this particular proposal still needs to be reviewed/approved and would need to be at least initially worked on by an admin in the dart-lang GitHub organization.

If you have feedback on a better name, that would of course be welcome :)

Okay 👍🏻

@atsansone
Copy link
Contributor

The only issue I see with dart-lang/website is that it can make working on multiple repos difficult if both display "website". I'm okay with site-www for now, though we could revisit it and maybe flutter as well.

I think dart-lang/dart.dev could be a winner.

@mit-mit : Any thoughts?

@atsansone atsansone added the review.pm Awaiting Product Manager Review label Sep 30, 2023
@shaikahmadnawaz
Copy link
Contributor

The only issue I see with dart-lang/website is that it can make working on multiple repos difficult if both display "website". I'm okay with site-www for now, though we could revisit it and maybe flutter as well.

I think dart-lang/dart.dev could be a winner.

@mit-mit : Any thoughts?

Agreed, dart.dev sounds like a suitable choice @atsansone @parlough

@parlough
Copy link
Member Author

parlough commented Sep 30, 2023

Thanks for your thoughts!

I do slightly prefer dart-lang/website (for the reasons noted earlier) but I'm also cool with dart-lang/dart.dev.

As a note for everyone, this issue is extremely low priority, but I opened it to collect feedback :)

@mit-mit
Copy link
Member

mit-mit commented Oct 4, 2023

I also slightly prefer /website. We generally have several cases where repo names are aligned across the Dart and Flutter github orgs.

@parlough
Copy link
Member Author

I'd really like to do this. I do think the name makes the repository harder to discover and it's just something else for people to remember.

Are there any known technical reasons this can't be updated to dart-lang/website? If not, I propose we just make the transition. GitHub maintains redirects and I'll happily handle updating references here and elsewhere so they are more accurate.

@mit-mit
Copy link
Member

mit-mit commented Jan 24, 2024

dart-lang/website SGTM

@atsansone any objections?

@parlough parlough changed the title Rename repository to dart-lang/website or dart-lang/dart.dev Rename repository to dart-lang/website Jan 24, 2024
@parlough
Copy link
Member Author

I discussed with Tony and he's okay with the change as long as I followup with some contribution doc adjustments.

No rush on these, but the update process will be something like:

  1. Update Cloud Build triggers for new nam
  2. Rename repository
  3. Land updates for new repository name ([Ignore] Updates links and references for repo rename #5492)

I'll start by touching base with Khanh on any necessary Cloud Build changes.

@parlough parlough self-assigned this Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
co.proposal Community ask to change an approach or process for docs.Dart.dev e2-days Can complete in < 5 days of normal, not dedicated, work infra.structure Relates to the tools that create dart.dev p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. review.pm Awaiting Product Manager Review
Projects
None yet
Development

No branches or pull requests

4 participants