Open parlough opened 1 year ago
Hello @parlough, can I work on this issue?
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 :)
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 👍🏻
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?
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 withsite-www
for now, though we could revisit it and maybeflutter
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
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 :)
I also slightly prefer /website
. We generally have several cases where repo names are aligned across the Dart and Flutter github orgs.
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.
dart-lang/website
SGTM
@atsansone any objections?
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:
I'll start by touching base with Khanh on any necessary Cloud Build changes.
Discussion
Problem:
Lack of discoverability:
site-www
is not a common repository name for open-source website repositories, so it can't be guessed.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.site-www
is not cleanly translatable compared to justwebsite
.Inconsistency:
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.
dart-lang/website
- Short, simple, and consistent. Doesn't need to change with new domain. Examples: docs.flutter.dev, go.dev, kubernetes.io, vitess.io, etcd.io, electronjs.orgdart-lang/dart.dev
- This seems popular and is very searchable but period is potentially confusing in links and for some tooling. Also might end up with issues from subdomains (likeapi.dart.dev
) Examples: react.dev, istio.io, lit.dev, haxe.org, astro.builddart-lang/docs
- Users could expect this repository to contain the API docs. Examples: tensorflow.org, vuejs.org, .NET, docs.astro.builddart-lang/dart-site
- This choice is so so, but not common and a bit repetitive sincedart
is already in the organization name.dart-lang/dart-dev
- Similar to currentdart-lang/pub-dev
, but it's not clear what this repository is about. Could be seen as thedart
tool from the name.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
dart-lang/website
,dart-lang/dart.dev
, or whatever is chosen. GitHub redirects links to the old destination to the new one automatically.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!