Skip to content

Commit c3b2160

Browse files
author
johndmulhausen
committed
TBDs
1 parent a2339bc commit c3b2160

File tree

1 file changed

+16
-106
lines changed

1 file changed

+16
-106
lines changed

proposals/digitalocean-droplet.md

Lines changed: 16 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -2,162 +2,72 @@
22

33
Authors: johndmulhausen
44

5-
Initial PR: #5
5+
Initial PR: #...
66

77
## Purpose & impact
88
#### Background & intent
99

10-
Currently all information about our "stack" is siloed across multiple websites
11-
that are in various states of maintenance. There is no place to learn how the
12-
various pieces of the stack such as libp2p, IPFS, Filecoin, IPNS, etc work
13-
together. There is also no place where the benefits of the W3DT stack can be
14-
expressed in a definitive and reliable place. The tech that drives our site
15-
(built on Vuepress) has to be kept in sync manually across multiple websites.
16-
This way, one code push elevates the documentation and user experience across
17-
all our offerings and the popularity of one offering can "boost" another as we
18-
begin to show the integration points.
19-
20-
Building a mental model of Web3 development is a primary adoption barrier for us,
21-
one that pairs very poorly with the difficulty inherent in experimenting with the tech
22-
itself. We need a place where we talk with a unified voice about how it's
23-
different, what its benefits are, why you would and wouldn't use it, how it
24-
compares to Web2, what good metaphors are in the current world for where we
25-
envision things going, and how the tech works together to address common
26-
scenarios in a unique way.
27-
28-
Onboarding is an art, and creating a golden path through our offerings that
29-
shows various pieces of tech working together will require all of us pulling on
30-
the same oar, not continuing to maintain our silos.
31-
32-
To continue to sink development time into any one particular website - such as,
33-
say, ipfs.io - is to create further inconsistency between experiences among our
34-
sites, and takes valuable development time away from dealing with our key
35-
problems: that we have too much to maintain and things are going stale, and we
36-
have no place to paint the whole picture and make the value clear. Symptoms of
37-
these core issues cropped up again and again in discovery.
38-
39-
To address an elephant in the room: we don't have to stamp "PL" onto a unified
40-
site. It can be at "w3dt.io," for example, and we can maintain an "About" page
41-
that talks about the team at PL that is tasked with the mission of bringing this
42-
tech to the world, as well as community and partner contributions and
43-
strenuously highlight that the tech consists of a collection of open-source
44-
projects. However, if the time has come to acknowledge these as PL projects, I
45-
think unifying the docs with protocol.ai would be fine, too.
10+
Ship one-click machine image for Lotus nodes so that it is easy to get started.
4611

4712
#### Assumptions & hypotheses
4813

49-
- There are too many repos
50-
- Sites are in a various state of maintenance
51-
- We are not clearly stating how tech works together
52-
- There is no easy path to upgrade all of our websites at once
53-
- There is very little "lift" from one technology being popular translating to another technology gaining in adoption
54-
- There is no place where we are onboarding people onto our stack as a whole or building a general W3 mental model
55-
- We are sinking time into maintaining siloed projects and there is an opportunity cost inherent there
14+
TBD
5615

5716
#### User workflow example
5817

59-
They would load this website. At first I presume we would have a simple project list, sort of like https://www.cncf.io/sandbox-projects/
60-
61-
In the long term we should build up scenario-based onboarding that is more
62-
geared towards building the mental model of how the stack solves problems, such
63-
as what you see at https://www.digitalocean.com/business/
18+
TBD
6419

6520
#### Impact
6621

6722
🔥🔥🔥
6823

69-
How can we even talk about the "web3 dev stack product-market fit" without a
70-
website that is dedicated to it, or without even regarding it as a stack in the
71-
first place?
24+
TBD
7225

7326
#### Leverage
7427

7528
🎯🎯🎯
7629

77-
The amount of distraction that would be avoided alone by trying to do this
78-
across multiple websites, projects, and repos justifies the project, but if we
79-
actually wnat to start convincing people that there is such a thing as a "web3
80-
dev stack" we need to take a stab at providing a "stack experience" complete
81-
with messaging, docs, and onboarding and getting feedback from devs who try to
82-
navigate it as we envision it.
30+
TBD
8331

8432
#### Confidence
8533

86-
High. We already have real world data here: the list of "assumptions" is
87-
actually just a restatement of problems we already spoke about together.
34+
TBD
8835

8936
## Project definition
9037
#### Brief plan of attack
9138

92-
1. Create new GitHub repo with a new VuePress site
93-
2. Declare "freeze" on existing docs repos, merge/close any open PRs, and pull in "final state" content, putting each tech into subfolders in the new repo
94-
3. Create front page using docs engine that introduces the mission and the various tech
95-
4. Create an "About" page
96-
5. Navigation design exercise: how does switching between projects feel on the site? What happens when you're three-levels deep into a navigation node?
97-
6. Ship
98-
7. Shut down old repos, post redirect scripts on old sites, and import relevant outstanding GH issues
39+
TBD
9940

10041
#### What does done look like?
10142

102-
There is one website and one repo with all the documentation in it.
43+
TBD
10344

10445
#### What does success look like?
10546

106-
If the project is successful, we should be able to say "yes" to these questions:
107-
108-
- Has traffic, forking/stars, and page ratings for docs on poorly-maintained projects gotten better?
109-
- Do we know where to post something that relates to the whole stack that teaches people high-level Web3 concepts?
110-
- Are we spending less time maintaining various sites, repos, and documentation sets and more time creating content?
111-
- Do we have greater awareness and understanding of the stack amongst ourselves and find ourselves more willing and able to pitch in across projects other than the ones we were working on previously?
112-
- Is it easier to upgrade the user experience and site functionality across our documentation offerings?
113-
- Are docs contributions from the outside world getting more frequent now that there's only one place to do them?
114-
- Are we able to replicate successes (such as delivering a good API docs implementation) that happen in one project (e.g. Filecoin) in another project?
115-
- Are GitHub issues staying open for a shorter amount of time now that they aren't being opened in poorly-monitored repos?
47+
TBD
11648

11749
#### Counterpoints & pre-mortem
11850

119-
It would only fail if we do not promote the site properly, or if the developer
120-
community decides there isn't value in our stack after engaging with our best
121-
effort at explaining it in one place with a unified voice and a golden path. In
122-
the case of the former, I would expect that such an important site would have
123-
great support from PL. In the case of the latter: if we are failing after
124-
unifying and clarifying our message to this degree, then there are bigger
125-
problems than just onboarding at play.
51+
TBD
12652

12753
#### Alternatives
12854

129-
There's not really an alternative to doing a unified site that would acheive the
130-
same thing as a unified site. There is either one repo and a unified docs
131-
experience, or there isn't. To some degree you could "fake" unification by using
132-
submodules across repos for things like navigation, etc, but that gets extremely
133-
messy and would actually end up increasing the amount of things to maintain
134-
rather than reduce them.
55+
TBD
13556

13657
#### Dependencies/prerequisites
13758

138-
The main pre-requisite is buy-in on the idea that this unified voice is possible
139-
without running afoul of PL's desire to remain at a certain "distance" from its
140-
projects. To consolidate this way is to present a certain point of view about
141-
how to apply our technology to the world. "Yes, these projects work together and
142-
are part of a common solution" - but whose? Whose point of view are we hearing? We
143-
have to address that concern. The implementation details are largely academic
144-
after that.
59+
TBD
14560

14661
#### Future opportunities
14762

148-
The creation of stack-wide solutions docs, stack-wide onboarding, and a huge
149-
increase in efficiencies w/r/t content creation.
63+
TBD
15064

15165
## Required resources
15266

15367
#### Effort estimate
15468

155-
- Medium, 3-5 weeks
156-
- Large, 6-10 weeks
69+
TBD
15770

15871
#### Roles / skills needed
15972

160-
- Docs writers are "all hands on deck"
161-
- PM to help drive buy-in and make sure consolidation runs smoothly across projects
162-
- Design should weigh in at a minimum but ideally would be engaged from the beginning
163-
- If design recommends radical changes from our current Vuepress docs implementation, some dev time will be required
73+
TBD

0 commit comments

Comments
 (0)