-
-
Notifications
You must be signed in to change notification settings - Fork 784
Adding initial content for Sprint Guide #609
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
base: lektor
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies for the delay in responding - I've been travelling for work, and wanted to give this the attention it deserves.
tl;dr - this is a great first pass. It's exactly what I had in mind - although there's some long comments/edits, that's more about polishing the content to a fine sheen rather than an indicator of anything fundamentally wrong.
Most of the comments I've left inline are aimed toward the general goal of making the text "bulletproof" as a standalone document. They err on the side of over-explaining, with a view to making sure that the core team needs to provide as little background or context for contributors that are coming in completely green to the process. That said - I've possibly over-corrected. If you think I've pushed too far in the over-explaining, or I've been too wordy (which... is a flaw I know I have in my writing :-) )that's entirely possible, so feel free to push back.
I haven't filled in any of the TODOs yet - my high level impression is "yes, those all look like they need to be TODone 😄". I'm not sure if you were planning to fill those in yourself once the high level structure was sorted, or if you're looking for direct input from me on those. If you want me to take a pass at any of them, I'm happy to do so (although I'll probably wait until I'm back at home next week and I can give them my full attention)
The one other detail I haven't looked at is how this document renders in the parent page. IIRC it's the "summary" section that will be rendered as a description on the "contributing" page; I want to make sure that it "fits" as part of that parent content.
Co-authored-by: Russell Keith-Magee <[email protected]>
I agree entirely with your aim here. I don't think you over-explained anything. I made a couple of minor changes, but I think you pretty much nailed it.
Hah! Yes, they do need to be TODone. The TODOs are the bits we didn't get to in our conversation that you need to get out of your brain. The "Common Questions" could be a group effort, really, but I mean group effort on the part of other Bee Team members. I'm happy to hop on another call next week when you're home again, and discuss things in more detail, if that's more convenient for you than filling things in yourself. However it happens though, the TODOs are yours. I basically took things as far as I could from my notes. You and I agreed on the last call that it made sense to wait on the details until we had this much done. And here we are!
Yes, the summary is what shows up. The current text is absolutely placeholder. At the moment, the link to the page is at the end of the Contributing page, as a header with the page title ("Sprint Guide"), and the summary text below it. If you want it somewhere else on that page location-wise, I will need some help because I don't understand how to make Lektor put a new subpage in the middle of the text content. It's clearly possible, the "First Time Contributors" subpage is first, but I'm unclear on what went into making that happen, even after looking at it and the Contributing page text. If last is fine, than the only thing needed to make it fit properly is updating the summary to something useful. I figured this would be the last thing on the list to do. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've had a chance to do a pretty heavy edit pass - at this point, I think all the TODOs are either Done or deleted; although there's a lot of changes, the first draft you've provided was invaluable.
Highlights of the update:
-
I've removed the "FAQ" section on the basis that I couldn't actually come up with anything that would have fitted in a FAQ better than an explicit section.
-
I've modified the questions so they're framed less as "7 questions each with 5 subquestions", any more in terms of "7 topics for a conversation we want to have about you". It's the conversation that we want to have, not just structured literal answers to a set of questions; my hope is that giving some background to why were asking might shake out some deeper answers, without needing to have a longer in-person script.
-
I've added some extra content providing an introduction to sprints (since that has historically been a point of confusion), links to contributions guides, "post contribution" workflow, and a few points doubling down on the "no dumb questions", "anti-imposter syndrome" stuff. The contribution guide links won't all be live yet - writing that section pointed out some inconsistencies that I'm working on upstream.
-
I've modified the content "situating" the sprints page. There are shortcodes so
beeware.org/b/sprints
will link to the sprint page; and the contributing page links to sprints as a special topic in the sidebar.
I'd appreciate any thoughts (and corrections!) - if I pointed you at this document as a first-timer, would I scare you off?
This page is intended to assist with guiding folks through the initial steps of joining the BeeWare sprints. The idea is to limit the amount of repeated instruction to folks who are joining for the first time, and hopefully provide a better experience for sprinters and the BeeWare folks alike.
Obviously the layout may not be what @freakboy3742 had in mind, so I'm submitting it as is for feedback.
At the moment, there are a number of TODOs on the page. I went through the basics with @freakboy3742, and the current content includes everything we discussed (or at least everything I managed to get into my notes). I'm happy to have another call to begin filling in the rest, or I'm also happy to hand it over at any time.
PR Checklist: