create account

Proposal: Hive Developer Documentation (Q2 2020) by inertia

View this thread on: hive.blogpeakd.comecency.com
· @inertia · (edited)
$9.63
Proposal: Hive Developer Documentation (Q2 2020)
<div class="pull-right">
  <img src="https://files.peakd.com/file/peakd-hive/inertia/GJOl9l19-image.png" />
</div>

The most up-to-date documentation available and will eventually be deployed to:

https://developers.hive.io

I did some initial rebranding and changed the welcome page to become Hive-specific.  The rest of the content still needs to switch to Hive.  That's not as simple as just doing a Global Search-and-Replace.  This has to be done carefully because some of the things under the hood haven't changed yet.

While a large amount of this proposal will be related to HF23 rebranding/fork, I still have a lot of ongoing work once that's complete.

Repository: https://gitlab.syncad.com/hive/devportal

As you can see, all of the documentation will be available open-source.  If you would like to contribute, please create an issue or pull request on the production repository, and I'd be happy to merge them.

#### Scope of Work

* Finish visual rebranding
* Replace Steem specific code with Hive, *where appropriate*
  * Includes converting all language specific tutorial sub-modules `<- most time consuming`
* Continue SMT API Definitions `<- 75% done, but unmerged`

#### Previous Proposals

My first proposal was [#10](https://hive.blog/steemdao/@inertia/hcihs-proposal-dev-portal-documentation), followed by [#39](https://hive.blog/steemdao/@inertia/proposal-dev-portal-documentation-q4-2019).

For last quarter, asking for full time pay wasn't accepted ([#63](https://hive.blog/steemdao/@inertia/proposal-dev-portal-documentation-q1-2020)).  Maybe it's because the amount was too high.  Maybe people felt there were more important things to worry about.

Thus, the daily amount I'm asking is `200 HBD`, total pay requested for the timeframe: `18,091 HBD`

#### Qualifications

Even before I was on the Steemit, Inc. staff, I had many projects that relied on a deep understanding of the platform.  Prior to the existence of the original devportal, I wrote clients and applications by relying on information all over the blockchain.

It'd be better if most people didn't ever have to do this kind of hunting.  My goals are not only to collect the information in one place but also verify the accuracy.

Because I write my own applications, I am constantly verifying this accuracy.  I am also able to iterate much faster than before, ~~now that I'm basically hosting the documentation myself.~~

**Update:** Hosting is now provided by @roelandp.

#### Proposal Details

[Approve](https://hivesigner.com/sign/update-proposal-votes?proposal_ids=%5B82%5D&approve=true&redirect_uri=https%3A%2F%2Fpeakd.com%2Fme%2Fproposals%2Finertia) / [Disapprove](https://hivesigner.com/sign/update-proposal-votes?proposal_ids=%5B82%5D&approve=false&redirect_uri=https%3A%2F%2Fpeakd.com%2Fme%2Fproposals%2Finertia)
https://peakd.com/me/proposals/inertia
Proposal timeframe: Q2 2020 (April 1 - June 30)
👍  , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , and 48 others
properties (23)
authorinertia
permlinkproposal-hive-developer-documentation-q2-2020
categoryhive-139531
json_metadata"{"app":"hiveblog/0.1","format":"markdown","description":"API Documentation; Proposal timeframe: Q2 2020 (April 1 - June 30)","countdown":"2020-06-30T19:00:00.000Z","tags":["hive","hivedocs","devportal"],"links":["https://developers.hive.io","https://gitlab.syncad.com/hive/devportal","https://hive.blog/steemdao/@inertia/hcihs-proposal-dev-portal-documentation","https://hive.blog/steemdao/@inertia/proposal-dev-portal-documentation-q4-2019","https://hive.blog/steemdao/@inertia/proposal-dev-portal-documentation-q1-2020","https://hivesigner.com/sign/update-proposal-votes?proposal_ids=%5B82%5D&approve=true&redirect_uri=https%3A%2F%2Fpeakd.com%2Fme%2Fproposals%2Finertia","https://hivesigner.com/sign/update-proposal-votes?proposal_ids=%5B82%5D&approve=false&redirect_uri=https%3A%2F%2Fpeakd.com%2Fme%2Fproposals%2Finertia","https://peakd.com/me/proposals/inertia"],"image":["https://files.peakd.com/file/peakd-hive/inertia/GJOl9l19-image.png"],"users":["roelandp"]}"
created2020-03-22 20:37:24
last_update2020-03-30 01:41:57
depth0
children10
last_payout2020-03-29 20:37:24
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value9.628 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length2,899
author_reputation346,568,901,399,561
root_title"Proposal: Hive Developer Documentation (Q2 2020)"
beneficiaries
0.
accountpeakd
weight500
1.
accountsteem.dao
weight9,500
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id96,543,874
net_rshares39,371,151,639,075
author_curate_reward""
vote details (112)
@hiveqa ·
Thanks, Inertia for all your hardwork. Voted!
properties (22)
authorhiveqa
permlinkre-inertia-q7m67l
categoryhive-139531
json_metadata{"tags":["hive-139531"],"app":"peakd/2020.03.9"}
created2020-03-22 21:26:09
last_update2020-03-22 21:26:09
depth1
children0
last_payout2020-03-29 21:26:09
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length45
author_reputation6,767,181,889,680
root_title"Proposal: Hive Developer Documentation (Q2 2020)"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id96,544,291
net_rshares0
@inertia ·
$0.04
**Proposal Update:** I have updated this proposal.  The scope of work has not changed, only the development targets:

|     | Original Target |     | New Target |
|---|-------|---|-------|
| Repository | https://github.com/quasistable/hivedocs | ➡️| https://gitlab.syncad.com/hive/devportal |
| Portal | http://hivedocs.info | ➡️| https://developers.hive.io |
👍  
properties (23)
authorinertia
permlinkq7v2b2
categoryhive-139531
json_metadata{"links":["https://github.com/quasistable/hivedocs","https://gitlab.syncad.com/hive/devportal","http://hivedocs.info","https://developers.hive.io"],"app":"hiveblog/0.1"}
created2020-03-27 16:40:15
last_update2020-03-27 16:40:15
depth1
children0
last_payout2020-04-03 16:40:15
cashout_time1969-12-31 23:59:59
total_payout_value0.040 HBD
curator_payout_value0.001 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length359
author_reputation346,568,901,399,561
root_title"Proposal: Hive Developer Documentation (Q2 2020)"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id96,602,787
net_rshares374,918,622,593
author_curate_reward""
vote details (1)
@oluwoleolaide ·
Great Job @inertia, would really love to see it accomplished.
properties (22)
authoroluwoleolaide
permlinkre-inertia-q7m4u7
categoryhive-139531
json_metadata{"tags":["hive-139531"],"app":"peakd/2020.03.10"}
created2020-03-22 20:56:45
last_update2020-03-22 20:56:45
depth1
children0
last_payout2020-03-29 20:56:45
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length61
author_reputation113,793,841,740,896
root_title"Proposal: Hive Developer Documentation (Q2 2020)"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id96,544,048
net_rshares0
@roelandp ·
$2.17
Hi Inertia. TBH I find the amount super high for adjusting the current docs (find Steem replace hive). Undoubtly you spend a lot of time when working for Steemit Inc to setup these docs (and possibly maintain them) and they are very valuable, so I don't want to discredit you at all and it would be great if you want to take up on the task of rewording them and maintaining them. 

However ....  

1. I find it odd (to say the least) you say you did some _"initial rebranding on the landing page - developers.hive.io"_ were you in reality so far had only pushed 2 changes in the configs for RubyGems on the _develop_ branch which is obviously not production branch (which I had setup, connected with auto-build and deploy on Amazon). All the changes prior to those 2 small ones by you had been submitted and pushed by me in the production environment. In other words: I did those changes to the landing page. 
2. I also find it odd you say you are "basically hosting the documentation" where in the past weeks prior to the official Hive launch made sure to have a Master/Develop branching, automatic build & deploy with Amazon S3 & cache invalidation. And guess what: That S3 bill is going to my creditcard... 


Why am I posting this? I don't want any credit for "work" I did in setting up this devportal deploy environment or any of other work I did related to it prior to the Hive launch and past week. Yet I don't like it you are now taking credit of stuff that I did. That's a lie and you know this. I would really appreciate openness and honesty, especially in regards to community funding. **I hope the above statements by your are somehow a mistake**, yet I find it hard to believe. If this announcement already contains these (for me) grave lies I find it hard to believe the documentation work and transparency around the usage of potential community funds will be done in fairness. 
👍  ,
properties (23)
authorroelandp
permlinkre-inertia-q7wjz8
categoryhive-139531
json_metadata{"tags":["hive-139531"],"app":"peakd/2020.03.12"}
created2020-03-28 11:59:33
last_update2020-03-28 11:59:33
depth1
children4
last_payout2020-04-04 11:59:33
cashout_time1969-12-31 23:59:59
total_payout_value1.084 HBD
curator_payout_value1.084 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length1,893
author_reputation662,936,810,561,284
root_title"Proposal: Hive Developer Documentation (Q2 2020)"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id96,612,371
net_rshares7,160,952,483,557
author_curate_reward""
vote details (2)
@inertia · (edited)
$2.92
Sorry for the confusion.  The initial rebranding I’m referring to is reflected on my initial repository that I set up prior to my discovery of developers.hive.io.  That initial work is here:

https://hive.blog/hive-139531/@inertia/q7v2b2

Unfortunately, I failed to update the paragraph in my proposal where I mention the hosting.  I’ll update that as soon as possible.

I wasn’t using anything elaborate, which is why it slipped my mind.  I just registered hivedocs.info (now obsolete) and intended to use Github Pages, which is very low cost.
👍  
properties (23)
authorinertia
permlinkq7wufv
categoryhive-139531
json_metadata{"tags":["hive-139531"],"app":"peakd/2020.03.12"}
created2020-03-28 15:45:33
last_update2020-03-28 16:38:12
depth2
children3
last_payout2020-04-04 15:45:33
cashout_time1969-12-31 23:59:59
total_payout_value1.458 HBD
curator_payout_value1.459 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length544
author_reputation346,568,901,399,561
root_title"Proposal: Hive Developer Documentation (Q2 2020)"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id96,614,920
net_rshares9,191,603,267,467
author_curate_reward""
vote details (1)
@roelandp · (edited)
Hi Inertia, ok cool thanks that clears things up. See if you can merge any of the CSS styling / rebranding you did into the Gitlab too then and or compare branches... Note that the `develop` branch automatically builds & deploys to https://developers-staging.hive.io . Once you are happy production can be build & deployed via a merge into `master`, which is a "protected" branch. 
properties (22)
authorroelandp
permlinkre-inertia-q7wv70
categoryhive-139531
json_metadata{"tags":["hive-139531"],"app":"peakd/2020.03.12"}
created2020-03-28 16:01:48
last_update2020-03-28 16:02:39
depth3
children2
last_payout2020-04-04 16:01:48
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length381
author_reputation662,936,810,561,284
root_title"Proposal: Hive Developer Documentation (Q2 2020)"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id96,615,129
net_rshares0
@steempeak ·
~300HBD less and shorter period... I mean sounds like a way more inviting proposal considering your last one was almost voted in. 
👍  
properties (23)
authorsteempeak
permlinkre-inertia-q7m4gl
categoryhive-139531
json_metadata{"tags":["hive-139531"],"app":"peakd/2020.03.10"}
created2020-03-22 20:48:24
last_update2020-03-22 20:48:24
depth1
children1
last_payout2020-03-29 20:48:24
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length130
author_reputation175,130,396,955,416
root_title"Proposal: Hive Developer Documentation (Q2 2020)"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id96,543,973
net_rshares47,345,836,226
author_curate_reward""
vote details (1)
@oluwoleolaide ·
Truly, I hope he gets all the votes needed for this.
properties (22)
authoroluwoleolaide
permlinkre-steempeak-q7m4zk
categoryhive-139531
json_metadata{"tags":["hive-139531"],"app":"peakd/2020.03.10"}
created2020-03-22 20:59:54
last_update2020-03-22 20:59:54
depth2
children0
last_payout2020-03-29 20:59:54
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length52
author_reputation113,793,841,740,896
root_title"Proposal: Hive Developer Documentation (Q2 2020)"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id96,544,082
net_rshares0