Rename "v2" branch to "main"

[sgillies]

@jreiberkyle we're not planning to merge v2 back to master, correct? What would you think about renaming it? Or at least making it the default branch?

cc @JuLeeAtPlanet @sarasafavi

[jreiberkyle]

I'm for making it the default branch. For one, it will allow us to automatically close issues from PRs. Additionally, it is the active development branch. Further, I think this can be done without much fuss.

As for renaming the branch, I am also for renaming it to "main" once @sarasafavi gives the go-ahead from a project/customer/communication management standpoint.

[sarasafavi]

+1 for v2 becoming default branch, woot

If we're also moving from master to main then let's split that move into a separate issue, so we can make sure we consider documentation changes it would require, etc.

[JuLeeAtPlanet]

On the up side, making main the default branch may correct the version number in the V2 doc builds.

Whereas the V1.4.9 docs on developers.planet.com, do use an iframe and pull in the github.io V1.4.9:

<iframe src="https://planetlabs.github.io/planet-client-python/index.html"

Not sure how github.io websites are generated, but this may be an issue to investigate.

[cholmes]

+1 here. Is there any reason to not do this soon?

[sgillies]

As far as I can tell, this is the current doc situation:

The v1 docs are built using GitHub Pages from the gh-pages branch and then are slurped into the devcenter site. They won't be affected by a v2 -> main rename.

It looks like the v2 docs are built on Read the Docs from config in mkdocs.yml. I'm almost certain that we'll need to get into our RTD account and turn on builds for "main" and make it the primary build after switching over.

[jreiberkyle]

@sarasafavi has info on how to access and change RTD

[sgillies]

We don't have integration between GitHub and RTD set up, so there are no automated doc builds. Last one was 6 months ago and I guess it was manually triggered.

I didn't find any references to the v2 branch in our code or docs outside of a v2_earlyaccess.md file. I'll make the edits there and rename now.

[sgillies]

v2_earlyaccess.md updated in fded5d3. Next: renaming using the project settings console. GitHub gives a sorta scary warning about this, but I feel good about it. We've been warning people off the master branch for a while and have already closed all the open PRs that target the master branch.

[sgillies]

Done!

GitHub provides these directions for updating your repo clones:

git branch -m v2 main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a