Add SDK_By_Examples to doc #1795

gamarin2 · 2018-07-23T13:59:40Z

Add sdk by examples to doc, so that we finally have something to point to.

The current example is self-sufficient. It contains a lot of content that will later be moved to other parts of the docs.

codecov · 2018-07-23T14:07:47Z

Codecov Report

Merging #1795 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1795   +/-   ##
========================================
  Coverage    63.46%   63.46%           
========================================
  Files          117      117           
  Lines         6927     6927           
========================================
  Hits          4396     4396           
  Misses        2276     2276           
  Partials       255      255

jbibla · 2018-07-25T13:02:02Z

docs/sdk/sdk-by-examples/intro.md

@@ -0,0 +1,7 @@
+**SDK by Examples** offers an alternative and complementary way to learn about the Cosmos-SDK. It contains several examples that showcase how to build a decentralised application on top of the Cosmos-SDK from start to finish.  
+
+Without further due, let us get into it!


Without further ado

jbibla · 2018-07-25T13:02:26Z

docs/sdk/sdk-by-examples/intro.md

+
+Without further due, let us get into it!
+
+- [Simple governance example](./simple-governance/intro.md)


only one example for to start?

yup, when we have other examples we'll add them to the list

jbibla · 2018-07-25T19:30:43Z

docs/sdk/sdk-by-examples/simple-governance/tendermint-cosmos.md

@@ -0,0 +1,25 @@
+## Tendermint and Cosmos


we have this section in the docs already - can we add this content there instead of duplicating ideas?

jbibla · 2018-07-25T19:31:27Z

docs/sdk/sdk-by-examples/simple-governance/testnet.md

@@ -0,0 +1,3 @@
+## Testnet


just delete this if it's not ready

But we'll get the question, so I feel it's good to have it apparent that it's WIP

what do you mean?

We will get questions around testet, how to create one, etc. If this is clear that this is WIP, we won't have to say it is WIP to everyone all the time :p

but why is this the place to talk about testnets? it's in the SDK by examples section under simple governance?

and there is no content yet...

Bec. when you code a SDK app you want to launch a testnet for it at the end. And the point is precisely to show that there is no content yet, so that we don't get the question "where is the content?" x1000

ok now i have a better understand of where you're coming from. thank you. it would seem to me that at the end of "building a dApp" you might want to do any number of things with it. one of which is launching your own testnet. maybe you want to connect to the hub or connect to an existing testnet. we should have content for all of these options - but since we don't - i'd prefer not to include a "TODO" in a production site.

when will the TODO be done?

can we either wait until then or remove it for now?

ok, I'll remove it for now

jbibla · 2018-08-10T14:00:24Z

docs/introduction/what-is-cosmos.md

@@ -1,7 +0,0 @@
-# What is Cosmos?


what is your thinking with regard to deleting this page?

wanted to replace it with smth else but ended up not doing it. I'm adding it back. Will improve it later.

jbibla · 2018-08-10T14:00:56Z

docs/sdk/overview.md

-model](https://en.wikipedia.org/wiki/Object-capability_model)
-and the [principle of least
-privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege).
+The [Cosmos-SDK](https://github.com/cosmos/cosmos-sdk) is a platform for building multi-asset Proof-of-Stake (PoS) blockchains, like the Cosmos Hub, as well as Proof-Of-Authority (PoA) blockchains.


is it a platform or a framework?

framework, modifying

jbibla · 2018-08-10T14:01:33Z

docs/sdk/sdk-by-examples/intro.md

@@ -0,0 +1,7 @@
+**SDK by Examples** offers an alternative and complementary way to learn about the Cosmos-SDK. It contains several examples that showcase how to build a decentralised application on top of the Cosmos-SDK from start to finish.  


👍👍👍

jbibla

well done @gamarin2 !!

jbibla · 2018-08-13T15:21:44Z

docs/sdk/sdk-by-examples/simple-governance/submit-proposal.md

@@ -0,0 +1,19 @@
+## Submit a proposal
+
+Uuse the CLI to create a new proposal:


* feat: add globalfee initModule for upgrade handler * chore: add comment for globalfee initModule * fix: lint

gamarin2 added 2 commits July 20, 2018 12:44

Add simple gov example and sdk-by-example folder

01ba6c3

Add simple gov example

d41b275

gamarin2 requested review from jbibla and zramsay as code owners July 23, 2018 13:59

gamarin2 added 2 commits July 24, 2018 16:06

Add simple gov example and sdk-by-example folder

64fb2bf

Add simple gov example

30e9ba4

gamarin2 force-pushed the gamarin/sdk_by_examples branch from d41b275 to 30e9ba4 Compare July 24, 2018 14:22

jbibla reviewed Jul 25, 2018

View reviewed changes

gamarin2 added 2 commits July 25, 2018 15:05

Add title

3de9196

fix sectino title

54b526c

jbibla reviewed Jul 25, 2018

View reviewed changes

rigelrozanski added T:Docs Changes and features related to documentation. ready-for-review labels Jul 31, 2018

rigelrozanski assigned jbibla Jul 31, 2018

Jb feedback + Offload some of the content in other docs

d7ce5ed

jbibla reviewed Aug 10, 2018

View reviewed changes

gamarin2 added 3 commits August 10, 2018 16:05

Add what is cosmos back

bacb74a

platform to framewoork

bb1bd22

Reemove testnet

d8369b9

jbibla approved these changes Aug 10, 2018

View reviewed changes

ebuchman merged commit c5fcc9b into develop Aug 12, 2018

ebuchman deleted the gamarin/sdk_by_examples branch August 12, 2018 07:37

jbibla reviewed Aug 13, 2018

View reviewed changes

gamarin2 mentioned this pull request Sep 25, 2018

R4R: Update doc on website #2403

Merged

chillyvee pushed a commit to chillyvee/cosmos-sdk that referenced this pull request Mar 1, 2024

feat: add globalfee initModule method for upgrade handler (cosmos#1795)

6d0c078

* feat: add globalfee initModule for upgrade handler * chore: add comment for globalfee initModule * fix: lint

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SDK_By_Examples to doc #1795

Add SDK_By_Examples to doc #1795

gamarin2 commented Jul 23, 2018

codecov bot commented Jul 23, 2018 •

edited

Loading

jbibla Jul 25, 2018

jbibla Jul 25, 2018

gamarin2 Aug 9, 2018

jbibla Jul 25, 2018

gamarin2 Aug 9, 2018

jbibla Jul 25, 2018

gamarin2 Aug 9, 2018

jbibla Aug 10, 2018

gamarin2 Aug 10, 2018 •

edited

Loading

jbibla Aug 10, 2018

gamarin2 Aug 10, 2018

jbibla Aug 10, 2018 •

edited

Loading

gamarin2 Aug 10, 2018

jbibla Aug 10, 2018

jbibla Aug 10, 2018 •

edited

Loading

gamarin2 Aug 10, 2018

jbibla Aug 10, 2018 •

edited

Loading

gamarin2 Aug 10, 2018

jbibla Aug 10, 2018

jbibla left a comment

jbibla Aug 13, 2018

		@@ -0,0 +1,7 @@
		SDK by Examples offers an alternative and complementary way to learn about the Cosmos-SDK. It contains several examples that showcase how to build a decentralised application on top of the Cosmos-SDK from start to finish.

		Without further due, let us get into it!


		Without further due, let us get into it!

		- [Simple governance example](./simple-governance/intro.md)

		@@ -0,0 +1,19 @@
		## Submit a proposal

		Uuse the CLI to create a new proposal:

Add SDK_By_Examples to doc #1795

Add SDK_By_Examples to doc #1795

Conversation

gamarin2 commented Jul 23, 2018

codecov bot commented Jul 23, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gamarin2 Aug 10, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbibla Aug 10, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbibla Aug 10, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbibla Aug 10, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbibla left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jul 23, 2018 •

edited

Loading

gamarin2 Aug 10, 2018 •

edited

Loading

jbibla Aug 10, 2018 •

edited

Loading

jbibla Aug 10, 2018 •

edited

Loading

jbibla Aug 10, 2018 •

edited

Loading