Proposal: Hive Developer Documentation (Q2 2020)

in HiveDevs5 years ago (edited)

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, followed by #39.

For last quarter, asking for full time pay wasn't accepted (#63). 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 / Disapprove
https://peakd.com/me/proposals/inertia
Proposal timeframe: Q2 2020 (April 1 - June 30)

Sort:  

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.

 5 years ago (edited) 

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.

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.

Perfect. I merged my hivedocs.info rebranding ideas to the staging devportal. I guess maybe we can do some A/B testing?

A: https://developers.hive.io/
B: http://developers-staging.hive.io/

Ha, thats a no-brainer.... B ofcourse :)

Proposal Update: I have updated this proposal. The scope of work has not changed, only the development targets:

~300HBD less and shorter period... I mean sounds like a way more inviting proposal considering your last one was almost voted in.

Truly, I hope he gets all the votes needed for this.

Great Job @inertia, would really love to see it accomplished.

Thanks, Inertia for all your hardwork. Voted!