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

Coursier Migration Blogpost #6400

Merged
merged 16 commits into from Aug 31, 2018

Conversation

Projects
None yet
4 participants
@wisechengyi
Copy link
Contributor

wisechengyi commented Aug 26, 2018

  • Add a Blogs section on the main page.
  • Add the blogpost itself

Preview: https://www.pantsbuild.org/staging/yic/coursier_migration.html

Initial discussion: https://groups.google.com/forum/#!topic/pants-devel/jtLtx6RUQMM

wisechengyi added some commits Aug 26, 2018

@benjyw
Copy link
Contributor

benjyw left a comment

Leaving the content aside (will review separately), this needs a new section of the site, with its own top menu "Blog" link. And this should have the look-and-feel of a blog, e.g., it should not show the documentation side menu, there should be a proper publish timestamp, and so on. This looks like every other documentation page, which seems wrong for both organizational and visual reasons.

Isn't it pretty easy to embed Medium posts? If so we should probably just do that. In fact, since Medium are, or at least were, using Pants, it seems like we should use their product. And we should be able to hit them up for help if we need it.

@wisechengyi

This comment has been minimized.

Copy link
Contributor

wisechengyi commented Aug 27, 2018

@benjyw Re structure on the doc page, are you suggesting the following?

Getting Started
	Installing Pants
	Setting Up Pants
	Tutorial
	Common Tasks
	Pants for Organizations

Pants Basics
	Why Use Pants?
	Pants Concepts
	BUILD files
	Target Addresses
	Third-Party Dependencies
	Pants Options
	Invoking Pants
	Reporting Server
	IDE Support
	JVM Support
	Python Support
	Go support for Pants

Code & Doc Generation
	Thrift
	Markdown

Getting Help
	Troubleshooting
	Community
	Reference
	Pants BUILD Dictionary
	Pants Reference
	Release Notes

Developer
	Pants Developer Center
	Export Format

Blogs
	Twitter's Coursier Migration

Re medium, it would be easier to have/create a pantsbuild medium account since Twitter does not have one yet, the process for Twitter to get one is likely going to be cumbersome, if not impossible.

@mateor

This comment has been minimized.

Copy link
Member

mateor commented Aug 27, 2018

I like the idea of a Medium pantsbuild page and a blog sidebar that links to it. Would likely reduce the amount of work for @wisechengyi as well

@benjyw

This comment has been minimized.

Copy link
Contributor

benjyw commented Aug 27, 2018

Yes, I mean none of that should exist on the blog post. It should look, well, like a blog post!

And yes, I meant a pantsbuild Medium account. Should be easy to get that set up. I can take a peek at it.

@stuhood

This comment has been minimized.

Copy link
Member

stuhood commented Aug 27, 2018

@benjyw : What changed since Yi asked about this pants-devel@ on August 3rd? It sounded like you were in favor of a "Blog" section then.

I'd be fine with having a Medium account, but once it was incorporated on www.pantsbuild.org, a static blog section (even with the exact format/layout of the release notes pages: eg, https://www.pantsbuild.org/notes-1.9.x.html) would have very low maintenance cost.

@benjyw

This comment has been minimized.

Copy link
Contributor

benjyw commented Aug 28, 2018

Nothing has changed. I AM arguing for a blog section!

When we discussed it in that thread I did not take "as part of the documentation" to mean literally just a documentation page, with the entire documentation sidebar menu and all the rest of our docs look-and-feel. I was imagining a Blog link in the top menu, and some sort of bloggy-looking thing under that...

How urgent is this to get out?

@wisechengyi

This comment has been minimized.

Copy link
Contributor

wisechengyi commented Aug 28, 2018

@benjyw Not super urgent, but it's been delayed for months for various reasons. If you think setting up medium may take a bit of time, how do you feel about landing this first with the changes to the doc structure as you suggested? It mainly serves a reference when folks are doing their migration.

We can then migrate it to medium at a later time.

@benjyw

This comment has been minimized.

Copy link
Contributor

benjyw commented Aug 30, 2018

Sorry for the delayed response on this. My week has been a fountain of chaos.

I did figure out that we can't use Medium, because they've deprecated support for hosting under your domain. There are plenty of alternatives, but for now, as you suggest, we may as well get this in, and figure out a better solution later.

@benjyw

This comment has been minimized.

Copy link
Contributor

benjyw commented Aug 30, 2018

That said, is there any site documentation on how to switch to coursier, apart from this blog post?

@benjyw

benjyw approved these changes Aug 30, 2018

@wisechengyi

This comment has been minimized.

Copy link
Contributor

wisechengyi commented Aug 30, 2018

@benjyw iiuc given the historical context, the tricky part is still how to get coursier to adopt ivy XMLs correctly. I don't think there's progress in that regard lately upstream in coursier.

The easiest way is still to adopt the maven repository layout for artifacts storage.

If it's a good idea, I can a line of disclaimer in the blogpost that maven style is required.

Once this pre-req is satisfied, it's just a matter of applying the option --resolver-resolver=coursier

fmt
@benjyw

This comment has been minimized.

Copy link
Contributor

benjyw commented Aug 31, 2018

Ah, I'm just asking if there's any existing documentation on how to do this. I don't need to use it myself right now...

My point is that while the blog post is very interesting, we'd also want a tl;dr version that is just "here's how to do this", just like the rest of our documentation.

@wisechengyi

This comment has been minimized.

Copy link
Contributor

wisechengyi commented Aug 31, 2018

Gotcha. I can add a tldr in a follow up patch.

@wisechengyi wisechengyi merged commit 432f030 into pantsbuild:master Aug 31, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@wisechengyi wisechengyi deleted the wisechengyi:blogpost branch Aug 31, 2018

@wisechengyi

This comment has been minimized.

Copy link
Contributor

wisechengyi commented Aug 31, 2018

Hi @benjyw, actually a while ago I updated https://www.pantsbuild.org/jvm_projects.html#toolchain with instruction how to use coursier. Is there any gap between that and the blogpost you are looking for?

@@ -0,0 +1,227 @@
# Twitter's Coursier Migration

## Meta Info

This comment has been minimized.

@stuhood

stuhood Aug 31, 2018

Member

This has the effect of rendering "Meta Info" in very large font, while the author and post date are deemphasized.

The three most important bits of info about a post (...according to most blogs I've seen) are 1) the title, 2) the date, 3) the author. And you were very much the author of this one, so you should absolutely 100% put your name in here. Crediting other folks who worked on the project by name / twitter handle is totally reasonable as well.

I'd also replace the "tags/abstract" with a more informal tl;dr.

@benjyw

This comment has been minimized.

Copy link
Contributor

benjyw commented Aug 31, 2018

No, that's probably sufficient.

wisechengyi added a commit that referenced this pull request Sep 6, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment