chainstack / docs Goto Github PK
View Code? Open in Web Editor NEWPlatform documentation
Home Page: https://docs.chainstack.com
Platform documentation
Home Page: https://docs.chainstack.com
Icebox for now
Track vuejs/vuepress/issues/1727 and implement when it's done in vuepress.
We don't need the prev/next links as they clutter up our docs and we make extensive use of the See also
section for a more efficient and precise guidance.
Scrub & crosslink articles once restructured
Add feedback information as a separate topic. Must include:
Example:
See also
section at https://docs.dev.chainstack.com/blockchains/Blockchains
sectionAdapt and publish https://hackernoon.com/executing-public-private-transactions-on-jpmorgans-quorum-with-web3-347190e3c35f to Tutorials section.
Do a MultiChain demo app and publish it in Tutorials
Adding this to backlog as a reference to #816.
The docs site currently doesn't match the UI and brand of Chainstack much in terms of colours and fonts.
We should make some small tweaks to align our properties more from a visual standpoint so that our brand is strong and persistent across the whole experience for users who interact with us.
Brand and style consistency
Usability
Update the UI on the docs site to be more inline with the rest of the Chainstack properties. This includes:
Out of scope:
We won't touch the design/layout of the documentation content itself
@easeev
@mcbzz
Interacting with nodes in a compatibility zone.
Write a MultiChain cold storage how-to and put it under Operations
if #34 goes through
Implement the changes to the new docs we agreed on with Eugene and Jona.
For Quorum and Ethereum, we need to show a warning to explain in the docs that the unprotected endpoints will be deprecated.
Explain the Gibibyte (Gi) notation for storage in control panel UI and put it in the docs
For Quorum & Remix for reference jpmorganchase/quorum/issues/549.
Trying to find the best structure and a unified experience for all docs sections.
I must template all how-to/operations sections and unify them under the template.
Examples:
Considerations:
Need to think, discuss, template, and then brush up.
Do instructions on how to make Quorum Geth from the latest release and put in Operations.
Opening most (but not all) sections in a new browser tab (eg CMD-click on macOS) shows the contents of docs/README.md
instead of the proper section.
Asset tokenization on Ethereum
section in the sidebar.The rendered text in the new tab is from docs/README.md
instead of the actual section.
In this new tab none of interactive elements load, so you can't browse and click the sidebar either.
A new tab opens with the proper section and the sidebar is interactive.
This happens with most of the sections in the scenario but not all.
From testing, I think the pattern is this (same both on dev and prod):
Fails:
Open a section that's not in the first group:
eg https://docs.chainstack.com/tutorials/academic-certificates-on-ethereum
CMD/CTRL-click on any other section that's not in the first group
eg Projects
> Consortium
.
Works:
Open a section that's not in the first group:
eg https://docs.chainstack.com/tutorials/academic-certificates-on-ethereum
CMD/CTRL-click on any section that's in the first group
eg Guides
> Getting started
. You will also notice here that it loads docs/README.md
for a split second before switching to Getting started
Note Local builds work fine.
Rework the current documentation structure around topic-based authoring.
@ThomasRalee while working updating the docs to reflect the protected Quorum APIs, I tested the Quorum food supply tutorial and it's not deploying anymore.
Note that I specify the .env
in the following format (just in case, I don't think this is the issue):
RPC1='https://user-name:[email protected]'
PK1='TRANSACTION_MANAGER_PUBLIC_KEY'
RPC2='https://user-name:[email protected]'
PK2='TRANSACTION_MANAGER_PUBLIC_KEY'
RPC3='https://user-name:[email protected]'
PK3='TRANSACTION_MANAGER_PUBLIC_KEY'
Whenever I run node public.js
it's failing with:
(node:8646) UnhandledPromiseRejectionWarning: Error: Returned error: authentication needed: password or unlock
at Object.ErrorResponse (/root/fuck/node_modules/web3-core-helpers/src/errors.js:29:16)
at /root/fuck/node_modules/web3-core-requestmanager/src/index.js:140:36
at XMLHttpRequest.request.onreadystatechange (/root/fuck/node_modules/web3-providers-http/src/index.js:96:13)
at XMLHttpRequestEventTarget.dispatchEvent (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request-event-target.js:34:22)
at XMLHttpRequest._setReadyState (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:208:14)
at XMLHttpRequest._onHttpResponseEnd (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:318:14)
at IncomingMessage.<anonymous> (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:289:61)
at IncomingMessage.emit (events.js:214:15)
at endReadableNT (_stream_readable.js:1178:12)
at processTicksAndRejections (internal/process/task_queues.js:77:11)
(node:8646) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:8646) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
Error: Returned error: authentication needed: password or unlock
at Object.ErrorResponse (/root/fuck/node_modules/web3-core-helpers/src/errors.js:29:16)
at /root/fuck/node_modules/web3-core-requestmanager/src/index.js:140:36
at XMLHttpRequest.request.onreadystatechange (/root/fuck/node_modules/web3-providers-http/src/index.js:96:13)
at XMLHttpRequestEventTarget.dispatchEvent (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request-event-target.js:34:22)
at XMLHttpRequest._setReadyState (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:208:14)
at XMLHttpRequest._onHttpResponseEnd (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:318:14)
at IncomingMessage.<anonymous> (/root/fuck/node_modules/xhr2-cookies/dist/xml-http-request.js:289:61)
at IncomingMessage.emit (events.js:214:15)
at endReadableNT (_stream_readable.js:1178:12)
at processTicksAndRejections (internal/process/task_queues.js:77:11)
This probably has to do with web3 version 1.2.1.
I'm assigning this issue to you for the time being. Please let me know how this can be fixed and I'll update the tutorial.
Currently we have 'google-analytics' and 'sitemap' plugins enabled by default:
Lines 51 to 61 in 3c3e6f3
They should be enabled only on production stand.
Implement a copy to clipboard feature for vuepress
Review the docs for Quorum nodes access and credentials and update the protected access instructions.
multichain hybrid installation
Scrub product and zendesk articles and links for validity.
Put in Corda > Tools.
Sources:
https://lankydan.dev/ktor-a-kotlin-web-framework
https://lankydan.dev/connecting-a-ktor-web-server-to-a-corda-node
Interacting with Quorum nodes.
Put it in docs
See if we need them at all and how to implement them https://vuepress.vuejs.org/default-theme-config/#prev-next-links
Chainstack is multi-cloud, multi-protocol Platform-as-a-Service. It automates DevOps process for public and consortium blockchain development. You can configure and deploy Ethereum, Quorum or MultiChain node using any cloud provider of your choice just with a few clicks.
You can try Chainstack for free here.
Your goal is to create a tutorial for new and existing Chainstack users that outlines the process of launching an application for public Ethereum. On a high level this tutorial should include 3 parts:
Smart contract in this tutorial should be a simplified version of a typical blockchain notarization application with the following functionality:
The tutorial has to use Truffle and Solidity for smart contracts.
You can use this example for the smart contract logic. Platform documentation can be used for the reference.
Figure out what Bolt is and publish to docs
Use vuejs/vuepress#1339 once it's released
Problem
We do not have consistency in styling with the Chainstack docs site compared to the rest of the platform's header and side nav.
Solution
Update the following items on the Docs site:
Reference | Link |
---|---|
Designs | Figma |
Header
Side nav
Review the docs at master for linting & consistency.
touchbase/kickstart July 17
Try building and running a CorDapp for docs tutorial
Do and release version 1 of our documentation style guide
The UI elements in docs must follow the industry-wide standards and be in bold.
Refs:
Icebox for now
There are several typos that exist in the new content found on the Chainstack docs.
Deploy an MultiChain node on Chainstack, and make a note of the connection details for the node.
Deploy an Quorum node on Chainstack, and make a note of the connection details for the node.
-"In this tutorial we will be writing a academic certificate generating DApp and will deploy it on public Ethereum node using Chainstack." This sentence structure feels odd in general.
-This is an ownable contract. It is implemented in a way that only authority can generate a certificate and only the contract owner can transfer his authority. (is this correct? personally not sure- should it be someone authorized?)
This is our main contract. It will handle the generation and verification of certificates.
generates a certificate by calculating a hash of student name and details
Investigate & fix.
Current behavior example:
Probably has to do with legacy structure indexed.
Add "Edit on Github" link to the docs.
Reasoning: fast feedback and contribution engagement
including the faucet info
also fix the ropsten mention here https://docs.chainstack.com/projects/public-chain#networks
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.