Light

andreamussap / axway_docs4all_hackathon Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 21.0 4.09 MB

Repository for 'Docs as code' project developed by team Docs4All for the Axway Hackathon 2019

Dockerfile 0.04% HTML 56.46% Shell 0.58% CSS 40.11% JavaScript 2.76% Ruby 0.04%

axway_docs4all_hackathon's Introduction

Hi there 👋

I'm a Technical Writer 📚 ✏️ and Data Analyst 📊 📈 enthusiast -

Anytime you use your phone, look up something online, stream music, shop with a credit card, post on social media, or use GPS to map a route, you're creating data. A digital world and the millions of smart devices inside of it have made the amount of data available truly mind-blowing. (Google Data Analytics Certificate)

I'm a driven and curious person, learning new tools and technologies motivates me, and I aim to apply these learnings to my job.

Find me 📫

GitHub stats

Volunteering

I like to volunteer with both technical and non-technical projects. There are many advantages of being a volunteer: contribute your knowledge and learn from peers, give back to the community, having purpose and feeling valued.

The following are some of the projects which I participate:

axway_docs4all_hackathon's People

Contributors

Stargazers

Watchers

axway_docs4all_hackathon's Issues

Create github repo

Create this repository for the project.
Update README file
Add collaborators (Alex, Natalia, Uzair

Convert HTML to kramdown Markdown

Description

We need a set of docs in markdown format for the hackathon project, so we can edit these docs in Netlifly CMS and on GitHub.

Convert 'API Gateway 7.7 Apache Cassandra Administrator Guide' to markdown

Tasks

Investigate/confirm that the markdown flavor must be kramdown to work with Jekyll.
Export Cassandra guide from Flare
Convert the files to markdown
Import files to this github repo

Set up Jekyll

Set up Jekyll version for windows locally using install instructions from https://jekyllrb.com/docs/installation/
paying with Jekyll local install by going through the https://jekyllrb.com/docs/step-by-step/01-setup/

Change site menu/title/colors

Tom Johnsons Jekyll template

Get TJ Jekyll template for a documentation website running locally.
Identify any requirements/limitations etc
Learn how to customize the menus to add new product/guide

Plug Cassandra markdown files into TJ doc theme

Update the top menu and side menu with links to the API Gateway/Cassandra guide markdown topics

Recommend Projects

React

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

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.