Giter VIP home page Giter VIP logo

dcrweb's Introduction

dcrweb

Build Status ISC License

Overview

This is the code for the decred.org website. It is built using the static site generator Hugo and utilizes Docker for testing and deployment.

Development

To start a development web server at http://localhost:1313:

./bin/watch.sh

Run the HTML validator to ensure all of the generated files are syntactically correct:

./bin/test.sh

Deployment with Docker

# Build the decred/dcrweb image.
./bin/build.sh

# Start the container.
docker run -d -p <local port>:80 decred/dcrweb:latest

Editing content

The most frequently updated content sections live in the below locations:

Section File
Media Coverage src/data/news/coverage.yml
Decred Journals src/data/news/decred_journals.yml
Software releases src/data/news/software_releases.yml
Press releases src/content/news/*.md
Wallets src/data/wallets/wallets.yml
Community channels src/data/community/channels.yml
Support channels src/data/community/support.yml
Publications src/data/community/publications.yml
Exchanges src/data/exchanges/*.yml

The other sections live under src/layouts. These pages are implemented as Hugo templates and are localized. The message catalogs can be found in src/i18n. When making changes in the templates, you'll want to keep the strings in the catalogs, please follow the naming scheme in the existing templates.

Localization

The below commands must be run when either the content changes or there are updates in the translations in Transifex. You'll first need to install the Transifex client.

Importing new translations and content updates

When translations are added/updated in Transifex, pull the updates:

./bin/transifex_pull.sh

When you run this for the first time, you'll be asked to log in with your Transifex username/password.

To push the changes to staging:

git commit -m "Translation update"
git push origin

Updating the message catalog

When the master content changes in the HTML files, you'll need to regenerate the message catalog and push it to Transifex so that translators can update the localized message catalogs:

./bin/transifex_push.sh

License

dcrweb is licensed under the liberal ISC License.

dcrweb's People

Contributors

alexlyp avatar artikozel avatar chappjc avatar dajohi avatar degeri avatar dezryth avatar dominicting avatar dreacot avatar exitus1 avatar hypernoob avatar infertux avatar insaf01 avatar jcvernaleo avatar jholdstock avatar jolan avatar jujhar avatar jzbz avatar karamble avatar nickboariu avatar noahpierau avatar oktapodia avatar orthomind avatar peterzen avatar pvtwarren avatar richardred0x avatar rmykolas avatar stabbarn avatar ttneverdies avatar xaur avatar zeroasic avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

dcrweb's Issues

Getting started content not visible after resizing

The whole "This tour will help you get started with Decred" section does not work properly when resizing to smaller browser windows. (For example if you want to view two windows next to each other) You can click on the titles but there is no content visible.

Team / Members section is missing.

Why no members section? Would be extremely good from a marketing perspective. High dollar investors invest in teams, yet, i fail to see a single team member on the main website? How is this cryptocurrency being built, who is leading it? Can i trust them? Who is developing decred? Am I inspired by previous projects they have worked on? Who is doing their marketing? Who is writing their documentation? Who is responsible for this sweet website? Is it all just materializing from the ether? I wish there was an easy way we could give recognition to all the people that help contribute to this project, while at the same time inspiring confidence in this great crypto project. If only there was a way.

Add localization selection/detection.

dcrweb is currently being translated into over a dozen languages by the #international_ops team (four are complete so far).

It would be nice to put the necessary pieces into place so we can offer users of the site the option to choose their native language and possibly even auto-detect the default browser language and show them the appropriate translation.

voting.decred.org link needed

we need to add a link to voting.decred.org

We realy need this main-navbar, will bug the branding team about this!

add decrediton windows release

Not sure if binary will show up today or not. Need to at least:

  • add link on downloads page

Depending on the quality/feedback:

  • change Windows download link at the top of the main page from paymetheus to decrediton?
  • change Windows download link in the tour portion of the main page from paymetheus to decrediton?

add OS detection to provide recommended downloads

An older revision of the site had some OS detection logic based upon platform.js:

https://github.com/bestiejs/platform.js/

We should bring this logic back so we can i.e. link Windows users to Paymetheus and macOS/Linux users to the proper version of Decrediton on the main site.

Maybe also do this on the downloads page for the CLI installer/gominer and provide direct links to the correct versions.

Basically we really want to do as much as we can to avoid dumping people onto the GitHub binaries/releases pages which are extremely difficult to navigate.

New Design with html, css, js and Fonts updates

We have to implement the new Design which was made by Lunnitee and Sander.

I will open a pull request with the new Design. The Stakepool List functionality needs a test and review by Jolan.

Navigation with upper right button is confusing

The menu button on the right upper corner is linking you to different destinations. Sometimes to a different section/view of the homepage (about, getting started), sometimes it's a different page (brand, downloads), and sometimes it's a different website (voting, blog, docs, stats).

Since it is not clear where you will end up, this may be confusing for some users. Especially when it directs you to a different page or website and the menu button disappears after navigating. What is more, most of the 'external' websites don't link back to the homepage (docs, blog, stats).

Some recommendations:

  • Consider a more consistent user experience by adding the menu button to all pages (and websites).
  • Let users know in advance if they are navigating away from the homepage
  • Provide a link back to the homepage from docs, blog, stats (and mainnet?).

Download links for China

GitHub uses AWS for serving files, so it is not possible to download anything linked on decred.org from inside China without the use of a VPN. Our Chinese users have resorted to re-hosting the binaries to get around this, however it is not ideal from a security standpoint as I'm sure few are verifying them with PGP.

If we could detect users from China and provide them with alternate download sources that would be ideal.

Always show "decentralized CREDIT"

Hovering over the main decred logo on the homepage shows a sub-text "decentralized CREDIT". It's not obvious that you can mouseover the logo and I only discovered it by chance.

Personally I think it would make a nice addition to the homepage if the sub-text was shown all the time.

It's been mentioned in Slack that people didn't know decred is an abbreviation of decentralized credit, and it was pointed out in the documentation survey that its not mentioned in the docs either (decred/dcrdocs#243).

Logo gets bumped out of view

Using Safari on macOS Sierra 10.12.4, when I go manually resize the browser window on my 2560x1080 display, it does this to the logo between 1/3 and 1/2 width:
screen shot 2017-05-12 at 8 56 15 pm

team page

decred.org site could use a team page, like what companyzero.com has, or the credits page that was put up https://www.exodus.io/decred/ . This can be evolved over time, and would just be a start for creating visibility for who is doing what.

Priority fixes

Alright so it seems some of the changes that have been implemented since adding the languages have caused a number of critical issues that need urgent fixing.

  1. Navigation button not clickable macOS 10.12 Safari

  2. All of the possible download versions are as visible buttons on mobile views below 768 px width breakpoint . So the download detection isn't working there. In the mobile views this should offer to re-direct to the downloads subpage and not suggest multiple or any options that are not relevant for the device.

screen shot 2017-08-19 at 14 35 53

  1. Tour Sections expandable points are all open/not working in a number of devices and browsers.

screen shot 2017-08-19 at 14 50 33

  1. The Statistics section isn't functioning (mac + ios safari and some windows phones)

screen shot 2017-08-19 at 14 45 19

A set from browserstack screenshots also:
browserstack - decred.org - 19082017.zip

Footer - Decred Developers

Minor perhaps, but will note it.

The wrapping looks off. If the div is too narrow, can we truncate to something that would fit on one line? Would be good for the DCR logo to be aligned with 1 line of copy. Maybe 'Decred 2015-2017' or 'Decred Developers' or 'Decred 2017'.

screen shot 2017-05-17 at 11 45 43 pm

site looks dope btw!

List of the Stakepools does not have a unique link

The list of different stakepools on the Decred network is missing an own link (similar to /downloads/ or /brand/). This makes it hard to share this stakepool list with people.

Currently the go-to-websites for the different stakepools are dcrstats.com (which favours its own stakepool) or docs.decred.org (which doesn't have live statistics).

Recommendation: add a unique link to make sharing easier.

Where to spend DCR

People on the documentation survey suggested a (curated) list of places where one could spend dcr. It was agreed that it is a nice idea, but not really something that belongs on the docs site so closing the issue decred/dcrdocs#261 in favor of this issue since it would make more sense on the website.

add downloads page

We should really have a page that lists the various downloads like is done on the bitcointalk thread, reddit sidebar, etc. Then we can remove those link lists in favor of linking to the new downloads page.

Should probably be broken into a few tables/sections like: graphical installers, commandline installers, binaries, copay. Perhaps needs the following columns Filename/Link, OS, Architectures, Notes.

Then we can link people to decred.org/downloads/#guiinstallers and maybe resurrect the javascript magic we had on the page previously to detect/highlight what is compatible with the system they're browsing on.

Integrating Forum with Slack channel

Decred forum are not seeing much activity these days and new users may think that we are a "dead" community when in actuality, 95% of the activity happens on slack.

A integration of a "trollbox-like" chat room on top of the forum that connects to Slack will reflect better our current level of activity.

Anchors for tours for easier navigation

index.html

line 155 - #overview
line 179 - #the-basics
line 205 - #decred-wallets
line 229 - #send-receive-decred
line 253 - #mining-decred
line 275 - #proof-of-work-mining
line 279 - #proof-of-stake-mining
line 322 - #buy-trade-decred
line 345 - #community
line 369 - #roadmap

something like that.

Most useful links at the top

What I miss from the old design are some useful links accessible without scrolling all the way down. In this case the loss in convenience is too big compared to the gain in good looking.

To my taste, at least these links should be available at the top: Docs, Forum, Network Stats, Source.

stake pool lister occasionally drops valid pools

When the stake pool list started filtering out pools stuck on API v1, there was a bug that caused pools with transitory issues/errors to be removed from the list.

This is due to a bug in the code where it woudn't preserve the dectected API v2 status and would then filter them out.

New mkdocs design

A Design rework is needed for the new communication design from Linnutee

Coding style

Hello,

Because the coding style is not consistent on the website js files, I would like to know if I can add a linter, do you have a preferred configuration?

I'm proposing eslint with the airbnb preset

Regards

Apple desktop OS format inconsistency

Apple's desktop OS is mentioned in different formats. It is written as: Mac OS X, Mac OS, or macOS.

It would be best to have one format, for example: MacOS.

Suggest about main page and wallet screen

Hi,

Now we have a pretty desktop wallet, i suggest to put some screen about it on the website as a showcase, because UI/UX is on the right direction and i think it's a shame to don't show it on the website knowing it can influence user to download the wallet and thus buy some coin.

Separate page for stake pools

The list of known stake pools is very important information.

I suggest to create a separate page for it, e.g. decred.org/stakepools

Currently one needs to scroll decred.org all the way down to the footer and click the Stakepools link, having javascript enabled (=> reduced accessibility).

I currently use dcrstats.com for a list of pools, but having an official page would be great.

While here (c), two extra columns would be very useful: Missed % (like dcrstats.com) and Age (how long this pool operates). These columns would help assessing the reliability of the pool.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.