Avoid using them simply to emphasize a single word, as in something like “Blockchain networks must use propery security protocols”. “A blockchain network contains a ledger, at least one chaincode, and peers”, especially if you’re going to be talking about those things in that paragraph. The best use of them is either as a summary or as a way of drawing attention to concepts you want to talk about.
#ROCKETCHAT MARKDOWN FREE#
This restriction is no longer necessary, so you are free to make lines as long as you want. If you look at the raw versions of the documentation, you will see that many topics conform to a line length of roughly 70 characters. While not all files use this standard, new files should adhere to it. For example, identity_use_case_tutorial.md. But excessive usage of any particular word has a tendency to have a numbing effect on the reader.īy using underscores between words. Of course sometimes it might not be possible to avoid this –– a doc about the state database being used is likely to be replete with uses of the word “database” or “ledger”. Not using it more than twice in a single paragraph is better. If you can avoid using a word twice in one sentence, please do so. Try to avoid using the same words too often. For example, “Software Development Kit (SDK)” on first usage. The first usage of an acronym should be spelled out, unless it’s an acronym that’s in such wide usage this is unneeded.
#ROCKETCHAT MARKDOWN CODE#
Avoid them unless you have a reason to use it (such as in a code snippet that includes it). It’s perfectly fine to use the “you” or “we”. Do not call it a “RAFT ordering service”. The Fabric CA client binary can, however, be referred to as the fabric-ca-client. The commands themselves are “curl” commands.ĭo not call it “fabric-CA”, “fabricCA”, or FabricCA. The same applies for any file format (for example, YAML). If you’re talking about several chaincodes, use “chaincodes”.Ĭolloquially, smart contracts are considered equivalent to chaincode, though at a technical level, it is more correct to say that a “smart contract” is the business logic inside of a chaincode, which encompasses the larger packaging and implementation. Don’t use “HLF” or “Hyperledger” by itself. The first usage should be “Hyperledger Fabric” and afterwards only “Fabric”. For an example, check out Use private data in Fabric. Tutorials should have a list of steps at the top.Ī list of steps (with links to the corresponding sections) at the beginning of a tutorial helps users find particular steps they’re interested in. Either be more explicit (for example, describing what “whitelisting” actually does) or find alternate words such as “allowlist” or “blocklist”. Unless the use of these words is absolutely necessary (for example, when quoting a section of code that uses them), do not use these words. When you choose Rocket.Avoid the use of the words “whitelist”, “blacklist”, “master”, or “slave”. With thousands of contributors and stars on Github, Rocket.Chat has the world’s largest community of chat developers in the open source communication sector. Users can set up Rocket.Chat on cloud or by hosting their own servers on-premises. Everyday, tens of millions of users in over 150 countries and in organizations such as Deutsche Bahn, The US Navy and Credit Suisse trust Rocket.Chat to keep their communications completely private and secure.īy opting for Rocket.Chat, users also benefit from free audio and video conferencing, guest access, screen and file sharing, LiveChat, LDAP Group Sync, two-factor authentication (2FA), E2E encryption, SSO, dozens of OAuth providers and unlimited users, guests, channels, messages, searches and files. The result is an increase in productivity and customer satisfaction rates. It enables real-time conversations between colleagues, with other companies or with your customers, across devices on web, desktop or mobile. Rocket.Chat is a customizable open source communications platform for organizations with high standards of data protection.
0 kommentar(er)
