Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Final updates for new docs website #5388

Merged
merged 247 commits into from
Dec 11, 2019
Merged

Final updates for new docs website #5388

merged 247 commits into from
Dec 11, 2019

Conversation

gamarin2
Copy link
Contributor

@gamarin2 gamarin2 commented Dec 11, 2019 •
edited
Loading

Description

Final polishing for launch of new docs site

For contributor use:

  • Targeted PR against correct branch (see CONTRIBUTING.md)
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards.
  • Wrote unit and integration tests
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/)
  • Added relevant godoc comments.
  • Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
  • Re-reviewed Files changed in the Github PR explorer

For admin use:

  • Added appropriate labels to PR (ex. WIP, R4R, docs, etc)
  • Reviewers assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

gamarin2 and others added 30 commits May 20, 2019 14:08
@gamarin2
consolidate intro
0125ca5
@gamarin2
Merge branch 'master' into gamarin/docs-update
9264ac3
@gamarin2
start anatomy of sdk app
a004c57
@gamarin2
wokring
07b7415
@gamarin2
working
4a86564
@gamarin2
querier
a9e303c
@gamarin2
working
0913fb6
@gamarin2
merg
167104c
@gamarin2
workiiiing
6346e8b
@gamarin2
finish
23f8f78
@gamarin2
add dep and makefile
9c2fd4e
@gamarin2 @alessio
Apply suggestions from code review
9baaed7 
Co-Authored-By: Alessio Treglia <quadrispro@ubuntu.com>
@gamarin2
typo
45f5654
@gamarin2
typo
265ed8e
@gamarin2 @alexanderbez
@fedekunze @alessio @rigelrozanski
Apply suggestions from code review
0a83404 
Co-Authored-By: Alexander Bezobchuk <alexanderbez@users.noreply.github.com>
Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
Co-Authored-By: Alessio Treglia <quadrispro@ubuntu.com>
Co-Authored-By: frog power 4000 <rigel.rozanski@gmail.com>
@gamarin2
refactor for new module interface
5f883fd
@gamarin2
pull
b06fafc
@gamarin2
karoly review
dde15ae
@gamarin2 @sabau @fedekunze
Apply suggestions from code review
da2514f 
Co-Authored-By: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
@gamarin2
encoding
56c3f5b
@gamarin2
working on baseapp doc
4f7c6b4
@gamarin2
baseapp work
e37310f
@gamarin2
reorg
92a0db9
@gamarin2
almost there
94664fe
@gamarin2
finish first draft
2624fec
@gamarin2
Merge branch 'master' into gamarin/baseapp
9aedc16
@gamarin2
remove old files
3496625
@gamarin2
module doc start
c90c997
@gamarin2
finish intro
1239fcb
@gamarin2
working
a2e24e8
@gamarin2 gamarin2 added R4R T:Docs Changes and features related to documentation. labels Dec 11, 2019
alexanderbez
alexanderbez approved these changes Dec 11, 2019
View reviewed changes
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delegating ACK (did not fully review). I would, however, love to see a solution soon to the

---
order: 7
---

that is found in markdown.

@gamarin2
Copy link
Contributor Author

@alexanderbez

Yes, as I said our next prio is to extend VuePress so that these don't render on github!

@codecov
Copy link

codecov bot commented Dec 11, 2019

Codecov Report

Merging #5388 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #5388      +/-   ##
==========================================
- Coverage   54.53%   54.51%   -0.02%     
==========================================
  Files         311      311              
  Lines       18740    18740              
==========================================
- Hits        10219    10217       -2     
- Misses       7741     7743       +2     
  Partials      780      780
Impacted Files Coverage Δ
x/mock/app.go 62.83% <0%> (-1.36%) ⬇️

@fedekunze fedekunze merged commit 7c9164c into master Dec 11, 2019
@fedekunze fedekunze deleted the master-docs branch December 11, 2019 17:35
xiangjianmeng pushed a commit to xiangjianmeng/cosmos-sdk that referenced this pull request Dec 18, 2019
@gamarin2 @xiangjianmeng
Final updates for new docs website (cosmos#5388)
dfc5585 
* consolidate intro

* start anatomy of sdk app

* wokring

* working

* querier

* working

* workiiiing

* finish

* add dep and makefile

* Apply suggestions from code review

Co-Authored-By: Alessio Treglia <quadrispro@ubuntu.com>

* typo

* typo

* Apply suggestions from code review

Co-Authored-By: Alexander Bezobchuk <alexanderbez@users.noreply.github.com>
Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
Co-Authored-By: Alessio Treglia <quadrispro@ubuntu.com>
Co-Authored-By: frog power 4000 <rigel.rozanski@gmail.com>

* refactor for new module interface

* karoly review

* Apply suggestions from code review

Co-Authored-By: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com>

* encoding

* working on baseapp doc

* baseapp work

* reorg

* almost there

* finish first draft

* remove old files

* module doc start

* finish intro

* working

* workinnn

* add transactions into core

* hans comments

* add transactions into core

* working

* gautier comments

* clean

* working

* consolidate intro

* querier

* workiiiing

* refactor for new module interface

* karoly review

* working on baseapp doc

* baseapp work

* reorg

* almost there

* finish first draft

* remove old files

* finish intro

* workinnn

* initial commit after rebase

* query-lifecycle and started modules-interfaces

* query-lifecycle first draft done

* module interfaces first draft

* rest and intro skeletons

* rest and intro done

* small edits and links

* comments

* revisions

* cli.md comments

* comments

* minor edits

* better flow for query lifecycle

* add transactions into core

* hans comments

* add transactions into core

* checkout master-docs files

* deleted some

* remove modules readme

* cli.md comments

* comments

* module-interfaces comments

* Merge PR cosmos#4857: Add Context concept doc

* working

* working

* finish messages and queries

* handler

* querier

* last comments!

* punctuation

* querier2

* consolidate intro

* querier

* workiiiing

* refactor for new module interface

* karoly review

* working on baseapp doc

* baseapp work

* reorg

* almost there

* finish first draft

* remove old files

* finish intro

* workinnn

* initial commit after rebase

* query-lifecycle and started modules-interfaces

* query-lifecycle first draft done

* module interfaces first draft

* rest and intro skeletons

* rest and intro done

* small edits and links

* comments

* revisions

* cli.md comments

* comments

* minor edits

* better flow for query lifecycle

* checkout master-docs files

* deleted some

* remove modules readme

* cli.md comments

* comments

* module-interfaces comments

* keeper

* genesis

* finish

* Apply suggestions from code review

Co-Authored-By: Hans Schoenburg <hschoenburg@users.noreply.github.com>

* hans review

* Update docs/core/baseapp.md

Co-Authored-By: Hans Schoenburg <hschoenburg@users.noreply.github.com>

* working

* last comment

* workin

* Apply suggestions from code review

* encoding and node

* almost finish store

* finish docs

* fixes

* fede comments + permalinks

* hans review

* add more permalinks

* update docs theme version (cosmos#5239)

* R4R: Docs Cleanup (cosmos#5246)

* start

* work

* work

* work

* remove table of content

* links intro

* fix links

* remove junk

* cleanup

* cleanup

* work

* finish cleanup

* addback readmes

* remove nft

* fix links

* remove dup

* remove dup

* remove dup

* remove dup

* remove dup

* fix links

* add subscribe events

* refine rest

* index page

* sidebar

* theme version

* theme version

* testing netlify

* theme version

* tooltip example

* version

* testing code embedding

* reverting back

* theme version

* version

* version

* version

* readme and version

* cleanup

* redo app anatomy

* modules readme, theme version

* theme version

* fix modules list

* theme version

* new snippets

* modules readme

* update docs readme

* modify synopsis

* version

* fix yaml

* version

* version

* version

* version

* version

* version

* version

* version

* version

* version

* add hide banner

* version

* version

* version

* small fixes

* modules readme, version

* remove hotkeys dep, version

* version

* version

* version

* version

* version

* version

* version

* slight notice

* fix links and hide

* permalinks

* small clean

* version

* resolve conflicts, add google analytics

* fix merge remants

* version

* changelog 1/2

* Changelog: docs UI

* version

* remove merge conflicts

* Code: Update link for Contributing to the docs to docs_readme

* HTML/CSS: Update layout of homepage footer to match new layout in Figma

* version

* final modifs

* modules, version

* modules readme

* link to module list from homepage

* version

* building modules link

* version

* version

* fonts

* version

* Update post.sh
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fedekunze fedekunze fedekunze approved these changes

@alexanderbez alexanderbez alexanderbez approved these changes

@alessio alessio Awaiting requested review from alessio

@jackzampolin jackzampolin Awaiting requested review from jackzampolin

@rigelrozanski rigelrozanski Awaiting requested review from rigelrozanski

Assignees
No one assigned
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@gamarin2 @alexanderbez @fedekunze @glozow @jackzampolin @fadeev