Skip to content
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

Should we publish the presentations we're doing in the docs? #56

Open
adizere opened this issue Mar 8, 2023 · 4 comments
Open

Should we publish the presentations we're doing in the docs? #56

adizere opened this issue Mar 8, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@adizere
Copy link
Member

adizere commented Mar 8, 2023

Problem: I frequently refer to this presentation by Josef, either for my own reference, or for onboarding people (eg, Ali), or in the context of crafting a tweet.

I think it would be good to convert the presentation in a PDF format and publish it in the docs repo.

Future presentations

Note that

  • @alijnmerchant21 will hold a workshop at Gateway (June) and potentially presentations at EthParis and HackAtom in Seoul.
  • I will give a presentation at Gateway

so we will be accumulating a fair amount of interesting material. For education and transparency, it would be beneficial both for our team and our users to open these resources up and make them easily accessible.

@alijnmerchant21
Copy link

Thanks for bringing this up Adi! I resonate with you in the idea of keeping it together in one place for easy access - especially for onboarding & easy reference.

However, I have some hesitance when it comes to sharing it with the public. Here are some of my concerns:

  • The presentation shared at conferences change very frequently, so maintaining them would be an overhead.
  • We might announce things at conferences, which might be delayed more than we anticipate. It could be negative for team to not deliver in documented time.
  • Sharing it in the docs site could be - a little unclean. (Not a biggy, but just aesthetically!)

Here is my solution - we could document this in form of Blogs which could sit on CometBFT / Informal blogs on the website & medium page. Blogs are a great way of sharing updates without people expecting them to be updated.
We could of course reference those blogs from our docs site; would be much cleaner!

@adizere
Copy link
Member Author

adizere commented Mar 13, 2023

maintaining them would be an overhead.

Good point, I didn't think of this. I can see a simple fix: I don't think we should maintain presentations. Like an ADR, a presentation is a snapshot or a record in time. We simply upload each presentation, tag it with the date/time, publish it, and then refer people back to it. Or am I missing something?

We might announce things at conferences, which might be delayed more than we anticipate. It could be negative for team to not deliver in documented time.

Not sure I understand this part. Is this situation the concern?

  • say we're at a conference and announce releasing feature X at date Y
  • then date Y comes, but we're not ready.. now we're in a tough place because we broke our own deadline.

How does this situation relate to uploading the slides?

Sharing it in the docs site could be - a little unclean. (Not a biggy, but just aesthetically!)

I imagine it would be a simple download button. Agree it's not idea because there's no "integration" in the website. @aaronmw any thoughts here? We could publish the PDFs at slideshare or slides.com.

@alijnmerchant21
Copy link

We simply upload each presentation, tag it with the date/time, publish it, and then refer people back to it.

On the documentation site, there is a section called Past Presentations (TBD) and in that, we have all PDFs linked there to be downloaded or Slideshare link - Is that what you mean by uploading each presentation?

then date Y comes, but we're not ready.. now we're in a tough place because we broke our own deadline.

My concern was if we had the deadline documented at cometbft docs and did not adhere to it, it would be negative. However, if it's a pdf that is to be downloaded, then it is not a concern.

@adizere
Copy link
Member Author

adizere commented Mar 14, 2023

Thanks for the feedback and concerns Ali!

On the documentation site, there is a section called Past Presentations (TBD) and in that, we have all PDFs linked there to be downloaded or Slideshare link - Is that what you mean by uploading each presentation?

Yes.

Curious if @aaronmw has any thoughts here. @andynog also? Otherwise I think we should go ahead with this in Q2.

To be clear, I don't want to create additional work for us. Instead, this issue seeks to achieve the publishing of work we're doing anyway (presentations at conference, hackatons, demos) with a minimal overhead.

@adizere adizere added documentation Improvements or additions to documentation question Further information is requested labels Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
No open projects
Status: Todo
Development

No branches or pull requests

4 participants