Proposal: Dev Portal Documentation
Synopsis
I will provide documentation intended for application and tool developers who work on the Steem blockchain.
Timeframe
One month from the start of the approved proposal, from 2019-09-01 until 2019-09-30. Total pay requested for timeframe: 3770 SBD
Deliverables
For the duration of the proposal work timeframe:
- Periodic pull requests directed at the devportal github maintained by Steemit, Inc. to appear on https://developers.steem.io once merged.
- "API Definitions" section updates
- "Recipes" section updates, which are programming-language-agnostic tutorials
- Maintenance of existing documentation to ensure ongoing relevance.
- Ongoing staged versions of the documentation to appear on inertia186.github.io/devportal, in cases where Steemit, Inc. is blocked (too busy) to merge the changes to the official devportal.
- Updates using decline-payout-posts to detail ongoing deliverables in the timeframe.
Rational for Proposal Funding
Using the proposal system means I can decline-payout for related posts, be compensated by SPS Inflation, and thus avoid seeking compensation through Reward Pool Inflation for these deliverables.
In a sense, my ultimate goal is to turn this SPS Inflation into demand for STEEM Power by empowering application developers to expertly deploy Steem applications, leading to their continued desire to power up.
Qualifications
I was on the Steemit, Inc. payroll for 10 months. During that time, I learned the development philosophy and culture and I was part of a developer group called SteemWorks.
I am also accomplished at reverse-engineering, which is a requirement for doing heavy documentation on the Steem blockchain.
Previous Work
During my time at Steemit, Inc., I was part of the team that contributed to the following devportal updates:
- Dev Portal Update: New Steem Developer Resources
- Dev Portal Update #2: Ruby, JavaScript, AppBase API Calls, Testnet Documentation
- DevPortal Update #3: UX Improvements, More Javascript Tutorials and More!
- DevPortal Update 4: Javascript, Contribution Guidelines, Search
- DevPortal Update 5: Jussi, SteemConnect, Improved Structure, and Recipes
- Dev Portal Update: Tutorials, Recipes, and Tweaks, Oh My!
- Steemworks Update: TestNet and DevPortal Improvements
- Steemworks Update: Backfill, Twitch in Condenser, and Easy Account Creation on TestNet
Since then, I have provided several updates to the official devportal, which have all been merged by Steemit, Inc.:
- Steemit Dev Portal: Document Transaction Polling API
- Steemit Dev Portal: Document Transaction Polling Recipe
- Steemit Dev Portal: Add Reputation API Definitions
- Steemit Dev Portal: Document Plugin & API List
- Documenting Reputation and Database API Definitions
- Steem Documentation: Full Node Quickstart
Proposal Approval/Rejection Criteria
You should approve this proposal if you would like me to be compensated through SPS Inflation rather than the Reward Pool Inflation.
You should reject this proposal if you would prefer that I continue to seek compensation through Reward Pool Inflation and upvotes.
To approve, please find the link below. If you have already approved, but have subsequently changed your mind, there is also an option to remove your approval.
To reject, just ignore this proposal.
Proposal Record
Also see:
I'am IN - first proposal that makes sense for me!
I would also vote for a proposal maintaining / improving https://github.com/steemit/steem-js library.
:D
Voted approved.
This is a good proposal idea but are you seriously asking for 130,000 SBD for a months work that is mostly done already? Seems a bit much
Hm, on steempeak I see 3,770 SBD total pay. The second link you put. On the first link it shows 130,000 SBD?
According to https://steemproposals.com/proposals it's actually total pay of 3,770 SBD for a month which sounds reasonable to me.
It's equal to the blockchain data:
According to my screenshot and the other link it's 130,000 SBD which is pretty clearly a mistake. That's why I'm working to get to the bottom of the bug so it can be reported to the proper developer.
Since @inertia didn't put the daily pay request in this proposal post I had to follow the links to the proposals to figure it out to decide if the proposal even made sense. In doing so, I found two different values. I'm a dev and can easily query the blockchain but the point of this is for it to be better UX for average users as well.
Btw it isn't a big even it's just a use of a comma instead of a period, which is common in other countries besides America. The screenshot I posted is showing daily pay as 130,000 SBD when that is 130 SBD x30 would be around 3900
The proposal makes sense with these numbers and I can now suggest to the creator of steemproposals to make the daily pay less ambiguous
Good point, I should have at least listed some kind of amount. I added it just now.
It is kind-of a chicken-and-the-egg experience for these early proposals. I envision the UX improving to the point where proposal creation is a single form. In this case, I wanted to make sure the scope of work was well defined so I could figure out how to fill in the numbers for the actual proposal.
Turns out, I picked 29 days from the datepicker UI, instead of 30. I should have specified exactly 12:00 AM on the first day and 11:59 PM on the last day.
The woes of the SPS! I'm sure everything will iron out.
Yep. Maybe I should emphasize that I'm happy with it so far. The UI we have is not bad for the first 24 hours of the mainnet hardfork.
It's 3,770 SBD total pay.
Yeah, looks like steemproposals.com has some localization issues.
130,000 SBDshould be displayed as130.000 SBD(daily rate).All fixed now. Thanks for noticing the issue.
steempeak still seems to show this 130 THOUSAND SBD number that is really making people .prematurely and unnecessarily .. jealous :D
To avoid confusion, all Steem front-ends and Steem-related sites should display only two digits after the decimal sign, whether it's a point or a comma.
There will be no 130SBD per day on Sep 1.
Proposals pays only 1/100 of its budget daily.
And it grows only about 2K SBD per day. So on Sep 1 max payment will be around 80 SBD
Approved!
The Documentation is a huge benefit!
yes if anyone deserves 130 SBD or 130 THOUSAND SBD for documentation its inertia. and even tho its a steempeak fronte nd error displayingteh numebr mroe than hes really getting, peopel shoudl eb remidned that ocumentationand visual aids educationa supliments to documentation can help a lot of peopel become steem dveelopers
if devel;opers coem heer from ethereum and see all this beauytiful documentation they will be mroe willing to join team steem. so much we can do especialy when steem is cheap enoughf or peopel to buy a lot of!
Approved!!
Thank you for providing me as a downvotes sacrifice for me I did not have one since you ask for it, I like to take you on.
This post has been included in the latest edition of The Steem News - a compilation of the key news stories on the Steem blockchain.
I voted for your proposal.
Hi, @inertia!
You just got a 0.84% upvote from SteemPlus!
To get higher upvotes, earn more SteemPlus Points (SPP). On your Steemit wallet, check your SPP balance and click on "How to earn SPP?" to find out all the ways to earn.
If you're not using SteemPlus yet, please check our last posts in here to see the many ways in which SteemPlus can improve your Steem experience on Steemit and Busy.