Coder Social home page Coder Social logo

redis-developer / redis-developer.github.io Goto Github PK

View Code? Open in Web Editor NEW
46.0 7.0 142.0 793.44 MB

The Home of Redis Developers

Home Page: https://developer.redis.com

JavaScript 13.73% CSS 1.65% SCSS 19.11% HTML 0.02% TypeScript 65.49%
redis redistimeseries redisgraph redis-server redis-client redis-cache redis-cache-store redis-cluster redisinsight terraform

redis-developer.github.io's Introduction

stars forks issues Twitter

Redis Developer Hub

Redis Developer Hub is basically a journey carved out for Redis developer community. The journey is defined in terms of "Create > Develop > Explore" . The "Create" section allows you to get started with Redis, creating Redis database locally as well as over Cloud in the form of DBaaS. The "Develop" section allows you to build your app using Redis clients. Finally, the "Explore" section helps you to explore your Redis database using robust tools like RedisInsight, Redis Data Source for Grafana, RIOT and many more...

Table of Contents

  1. How to contribute?
  2. How to add a new author?
  3. How to modify the homepage banner

How to contribute

This website is built using Docusaurus 2, a modern static website generator. Follow these steps to contribute to this developer site:

Note: You should use Node 16. If using nvm, type nvm use before installing.

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Testing the local site

npm run serve

How to add a new author

Add a new author as follows:

  • Edit docusaurus.config.js and add a new author object into the authors object:
customFields: {
  authors: {
    simon: {
      name: 'Simon Prickett',
      link: 'https://twitter.com/simon_prickett',
      title: 'Manager, Developer Advocacy',
      image: 'profile_pic_simon_prickett.jpg'
    },
    suze: {
      name: 'Suze Shardlow',
      link: 'https://suze.dev',
      title: 'Developer Community Manager',
      image: 'profile_pic_suze_shardlow.jpg'

    }
  }
},
  • Give each author a unique name in the authors object.
  • The link field can be set to any of your social media profiles or personal website etc.
  • The image field is optional. If omitted, a default silhouette image will be used.
  • If providing a value for the image field, please name your image profile_pic_<author_name>.jpg|.png and add it to the static/img folder.
  • Make sure that the image is 640px square and use a service such as tinypng.com to reduce the file size.
  • When you want to tag a document as written by the new author, edit its front matter e.g.:
---
id: index-hacktoberfest
title: Hacktoberfest 2021 at Redis
sidebar_label: Hacktoberfest 2021
slug: /hacktoberfest/
authors: [suze,simon]
---
  • Note that multiple authors are supported as shown above.

Suppressing Next/Previous and Edit this Page Controls

By default, each page has navigation at the bottom for the next and previous pages, as well as an "Edit this page" link. If you want to suppress all or some of these, add the following extra front matter to your page's .mdx file:

custom_edit_url: null
pagination_next: null
pagination_prev: null

How to modify the homepage banner

In order to modify the homepage banner, you will need to edit the docusaurus.config.js file placed under the root of the repository. You can directly search for announcementBar and make your preferred changes.

announcementBar: {
       id: 'redisconf20201cfp', // Any value that will identify this message.
       content: '<p class="text"> RedisDays Available Now On-Demand. </p> <a href="https://redis.com/redisdays/" target="_blank" rel="noopener"     class="btn">Learn More</a>',
       //  content: '<p class="text"></p> <a href="https://redislabs.com/redisconf/" target="_blank" rel="noopener" class="btn"></a>',
       backgroundColor: '#fff', // Defaults to `#fff`.
       textColor: '#000', // Defaults to `#000`.
       isCloseable: true, // Defaults to `true`.
     },

redis-developer.github.io's People

Contributors

abrookins avatar ajeetraina avatar banker avatar bsbodden avatar chayim avatar educarneiro avatar elena-kolevska avatar goatatwork avatar guyroyse avatar imichaelowolabi avatar justincastilla avatar limburns avatar michaelatredis avatar pawel-orzechowski avatar prasankumar93 avatar redistmill avatar roj1512 avatar ryanrussell avatar sachin-kottarathodi avatar sav-norem avatar simonprickett avatar skonaads avatar slorello89 avatar snoojen avatar suzeshardlow avatar tgrall avatar trinidadgithub avatar vikrammoule-redislabs avatar whaty avatar wjohnsto 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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

redis-developer.github.io's Issues

Disable Dark Mode Toggle

Please disable the toggle. The team is working on the CSS but it won't be ready for this launch.

Update Docusaurus Config

In docusaurus.config.js, please update these two items as the following:
title: 'Redis Developer Hub', tagline: 'The Home of Redis Developers',

Include Google Tag Manager (GTM)

## Add just before closing of head tag
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-XXXXXX');</script>
<!-- End Google Tag Manager -->
## Add just after opening of body tag
<!-- Google Tag Manager (noscript) -->
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-XXXXXX"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager (noscript) -->

Recent changes make `node-sass` fail with node 15.x

➜ node -v
v15.5.1

➜ yarn -v
1.22.10
[6/7] ⠐ node-sass
error/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-sass: Command failed.
Exit code: 1
Command: node scripts/build.js
Arguments:
Directory:/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-sass
Output:
Building: /usr/local/Cellar/node/15.5.1/bin/node/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-gyp/bin/node-gyp.js rebuild --verbose --libsass_ext= --libsass_cflags= --libsass_ldflags= --libsass_library=
gyp info it worked if it ends with ok
gyp verb cli [
gyp verb cli   '/usr/local/Cellar/node/15.5.1/bin/node',
gyp verb cli   '/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-gyp/bin/node-gyp.js',
gyp verb cli   'rebuild',
gyp verb cli   '--verbose',
gyp verb cli   '--libsass_ext=',
gyp verb cli   '--libsass_cflags=',
gyp verb cli   '--libsass_ldflags=',
gyp verb cli   '--libsass_library='
gyp verb cli ]
gyp info using [email protected]
gyp info using [email protected] | darwin | x64
gyp verb command rebuild []
gyp verb command clean []
gyp verb clean removing "build" directory
gyp verb command configure []
gyp verb check python checking for Python executable "python2" in the PATH
gyp verb `which` succeeded python2 /usr/bin/python2
gyp verb check python version `/usr/bin/python2 -c "import sys; print "2.7.16
gyp verb check python version .%s.%s" % sys.version_info[:3];"` returned: %j
gyp verb get node dir no --target version specified, falling back to host node version: 15.5.1
gyp verb command install [ '15.5.1' ]
gyp verb install input version string "15.5.1"
gyp verb install installing version: 15.5.1
gyp verb install --ensure was passed, so won't reinstall if already installed
gyp verb install version is already installed, need to check "installVersion"
gyp verb got "installVersion" 9
gyp verb needs "installVersion" 9
gyp verb install version is good
gyp verb get node dir target node version installed: 15.5.1
gyp verb build dir attempting to create "build" dir:/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-sass/build
gyp verb build dir "build" dir needed to be created?/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-sass/build
gyp verb build/config.gypi creating config file
gyp verb build/config.gypi writing out config file:/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-sass/build/config.gypi
gyp verb config.gypi checking for gypi file:/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-sass/config.gypi
gyp verb common.gypi checking for gypi file:/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-sass/common.gypi
gyp verb gyp gyp format was not specified; forcing "make"
gyp info spawn /usr/bin/python2
gyp info spawn args [
gyp info spawn args   '/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-gyp/gyp/gyp_main.py',
gyp info spawn args   'binding.gyp',
gyp info spawn args   '-f',
gyp info spawn args   'make',
gyp info spawn args   '-I',
gyp info spawn args   '/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-sass/build/config.gypi',
gyp info spawn args   '-I',
gyp info spawn args   '/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-gyp/addon.gypi',
gyp info spawn args   '-I',
gyp info spawn args   '/Users/briansam-bodden/.node-gyp/15.5.1/include/node/common.gypi',
gyp info spawn args   '-Dlibrary=shared_library',
gyp info spawn args   '-Dvisibility=default',
gyp info spawn args   '-Dnode_root_dir=/Users/briansam-bodden/.node-gyp/15.5.1',
gyp info spawn args   '-Dnode_gyp_dir=/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-gyp',
gyp info spawn args   '-Dnode_lib_file=/Users/briansam-bodden/.node-gyp/15.5.1/<(target_arch)/node.lib',
gyp info spawn args   '-Dmodule_root_dir=/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-sass',
gyp info spawn args   '-Dnode_engine=v8',
gyp info spawn args   '--depth=.',
gyp info spawn args   '--no-parallel',
gyp info spawn args   '--generator-output',
gyp info spawn args   'build',
gyp info spawn args   '-Goutput_dir=.'
gyp info spawn args ]
No receipt for 'com.apple.pkg.CLTools_Executables' found at '/'.

No receipt for 'com.apple.pkg.DeveloperToolsCLILeo' found at '/'.

No receipt for 'com.apple.pkg.DeveloperToolsCLI' found at '/'.

gyp: No Xcode or CLT version detected!
gyp ERR! configure error
gyp ERR! stack Error: `gyp` failed with exit code: 1
gyp ERR! stack     at ChildProcess.onCpExit (/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-gyp/lib/configure.js:345:16)
gyp ERR! stack     at ChildProcess.emit (node:events:376:20)
gyp ERR! stack     at Process.ChildProcess._handle.onexit (node:internal/child_process:284:12)
gyp ERR! System Darwin 19.6.0
gyp ERR! command "/usr/local/Cellar/node/15.5.1/bin/node" "/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-gyp/bin/node-gyp.js" "rebuild" "--verbose" "--libsass_ext=" "--libsass_cflags=" "--libsass_ldflags=" "--libsass_library="
gyp ERR! cwd/redis-developer.github.io/node_modules/docusaurus-plugin-sass/node_modules/node-sass
gyp ERR! node -v v15.5.1

Add alt tags to images

All images should have the alt tag properly completed. Imagine a visually impaired person and succinctly describe what the image represents.
alt="image description"

Python example code

We highly recommend showing a connection pool for every language as it solves a large portion of production issues.

Adding Best Practices section

Adding the best practices section would be great -

Best Practices / Guides  
  Security
  High-Availability
  Fast Ingestion
  Cloud Migration
  Import Data
  Data Modeling

Update pages Index File

In /src/pages/index.js, please update the following:
title={Welcome to the ${siteConfig.title} by Redis Labs} description="Learn all the best practices to get up and running with Redis in no time. Get started and discover the power of Redis, whether on your local machines or in the cloud.">

Needs a place to mount Tutorials

I'm working on a Spring Data Redis series of screencasts and an accompanying set of articles, one large, a tutorial, and then a few on refactoring certain aspects of the app. Ideally, we should have, per programming language and even per -framework, if there is enough content (like Spring.io):

  • Getting Started Guides: 15-30 minute read
  • Topical Guides: 60 minutes or less
  • Tutorials: 2-3 hours

Add RedisInsight specific topics

Add RedisInsight specific topics such as:

  • Memory analysis
  • Profiler
  • Automatic DB discovery
  • Cluster Management
  • Slowlog Configuration

Open External Links in new tab

By web convention, any link that is external (different nav, other domain, files) should open in a new tab.

Please add this to the external links as you see them.
target="_blank" rel="noopener"

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.