[wp-meta] [Making WordPress.org] #1103: Add WordPress Git & GitHub mirror docs to https://wordpress.org/download/

Making WordPress.org noreply at wordpress.org
Thu Jul 9 14:07:43 UTC 2015


#1103: Add WordPress Git & GitHub mirror docs to https://wordpress.org/download/
--------------------------+----------------------------------------
  Reporter:  netweb       |      Owner:  iandunn
      Type:  enhancement  |     Status:  assigned
  Priority:  normal       |  Component:  General
Resolution:               |   Keywords:  needs-patch good-first-bug
--------------------------+----------------------------------------

Comment (by netweb):

 Replying to [comment:6 iandunn]:
 > Maybe something like `/download/svn-git` would be more better? It'd be
 more specific and familiar than "VCS"; I'd worry that a lot of newer devs
 wouldn't recognize "VCS."
 I was thinking ahead for when the GitHub hashes are fixed ;) Though
 `/download/svn-git` could still include GitHub as it is still Git.

 > My first instinct would be to have separate sections for SVN and Git,
 rather than mixing the two. That way visitors could focus only on the
 parts that are relevant to them, and ignore the rest. That'd be quicker to
 scan, and would avoid people being confused about which commands to use.
 >
 > It'd also give us a better opportunity to highlight the differences
 between the two workflows. With Git it's important to stress the need to
 work on separate branches for separate tickets, generate patches with
 `--no-prefix`, etc.
 >
 > Although, that makes me wonder if the page should even be discussing how
 to generate patches and whatnot. It is a "download" page after all, not a
 "contribute" page. Now that we have the Core Handbook, I think it might be
 better to just have an intro about the history of WP's VCS usage, and show
 very brief info of how to check out/clone trunk, then link to the Core
 Handbook for details on a full contributing workflow.
 Agreed, so on the `/download/svn-git` page we'd only want: (With links to
 SVN/Git docs)

 ||`svn co https://core.svn.wordpress.org/trunk/`||`git clone
 https://core.git.wordpress.org/trunk/`||
 ||`svn update`||`git pull`||
 ||`svn status`||`git status`||

 And leave the "develop" repo for the Core Handbook page? (and creating
 patches etc)
 ||`svn co https://develop.svn.wordpress.org/trunk`||`git clone
 git://develop.git.wordpress.org/`||

 > The Handbook would need a Git equivalent to
 [https://make.wordpress.org/core/handbook/svn/ the SVN page] first,
 though, which would be really nice to have anyway. It could borrow some
 info from [https://make.wordpress.org/meta/handbook/documentation
 /contributing-with-git/ the Git page in the Meta handbook], but will have
 some significant differences because we have an actual Git repo for Core,
 rather than needing to use ''git-svn''.
 Likewise for the handbook `https://make.wordpress.org/core/handbook/svn-
 git` with the new Git changes added to existing SVN.

 > Thoughts on all that, everyone?

 Not sure on the layout, keeping them separate or inline as per my example
 above kind side-by-side, anyway there really isn't that much html to add
 for either page so cutting and pasting to rearrange shouldn't be too
 difficult.

--
Ticket URL: <https://meta.trac.wordpress.org/ticket/1103#comment:7>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org


More information about the wp-meta mailing list