Giter VIP home page Giter VIP logo

epages-docs's Introduction

epages-docs

CircleCI

Bootstrap your machine

Make sure that you have Ruby and Bundler installed on your machine. For platform specific instructions see the following subsections:

Mac OS X

You can use this shell script to turn your OS X laptop into an awesome web development machine.

Linux

You can use this shell script to turn your laptop into an awesome web development machine.

Windows

You can use the Vagrant or Docker options.

Run using Vagrant

Install Vagrant on your machine.

# This step will download and start the machine
$ vagrant up

# Here you can access the machine terminal
$ vagrant ssh

# Find out the ruby version
$ ruby -v

# Edit the file `.ruby-version` on epages-docs folder with your favourite editor and update with your version
$ vi /vagrant/.ruby-version

After this run the Rake tasks

Run in Docker (development mode)

If you don't like to bootstrap your machine you can also run a Docker container for development by invoking a single command only. The container will be pulled from our registry. Requirement: Install Docker Engine first.

# Build and run container with default rake task (eq. build `_site` and serve via jekyll)
$ docker build -t epages-docs -f Dockerfile.ruby .
$ docker run --rm --volume=$(pwd):/usr/src/epages-docs -p 4000:4000 -it epages-docs dev

# On Linux
$ echo "Open in browser: http://127.0.0.1:4000/"

# On Mac (with one active docker machine)
$ open http://$(docker-machine ip `docker-machine active`):4000

Run in Docker (production mode)

# build nginx and elasticsearch docker image
$ ./build.sh master "$(echo "${DOCKER_HOST}" | sed -E 's/tcp:\/\/([^:]+):([0-9]+)/\1/'):9200"
$ docker-compose up -d

Hints

  • By appending arguments after the image name at the listed docker run commands, you may execute other rake tasks (e.g. rake test, rake build, rake serve or in short: test, build, serve) as well as connect (e.g. bash) into the pseudo-terminal inside the container and do whatever you want.
  • When running the container with a mounted host dir the _site dir will be created on the host with docker access rights (user ids from the inside the container). You may sanitise this with sudo chown -R $USER:$USER _site afterwards or just remove it as root sudo rm _site.
  • docker pull/run of containers from our registry works without login inside our DMZ. From the outside you first need to run docker login accordingly.
  • Caution: For keeping things simple we run all commands inside the ruby container as root. In a production environment you would have to serve the jekyll site with user only privileges of course.

Rake tasks

# install dependencies
$ bundle

# run a local server with auto rebuilding
$ rake

# check for dead links and other bad stuff
$ rake test

# build the page
$ rake build

# compare status of RAML files from epages-docs with epagesj
$ rake ramlup

License

This project comprises different licenses. The editorial content in the folders

  • apps/,
  • blog/,
  • soap/ and
  • assets/images/

is licensed under CC-BY-4.0. The logos in the folder assets/logos/ may not be shared or adapted. The different fonts in the assets/fonts/ folder are licensed under their own respective licenses. All other content is licensed under MIT.

epages-docs's People

Contributors

aliamondo avatar alicestatler avatar bolsu avatar cgebken avatar choffmeister avatar dataduke avatar depoulo avatar djablonski avatar dkluever22 avatar dmoran-epages avatar erikmueller avatar gersanco avatar hgslv avatar jensfischer1515 avatar jmewes avatar k4th avatar kengallego avatar mduesterhoeft avatar mhoehn avatar mingoscd avatar mjger avatar mzeyen avatar netzfisch avatar ozscheyge avatar roseritter avatar thokari avatar ubep avatar unabris avatar unaitxu avatar ywolpers avatar

Stargazers

 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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

epages-docs's Issues

Subdocumentation

... for apps and themes separately.
And to being able to include several other documentation in future.

Clean up root directory

Please move the files

  • examples.md,
  • faq.md,
  • templates.md and
  • use-cases.md

into the pages/ folder. The four pages listed above are just ordinary pages that do not fit into a certain category. Hence it makes sence, to have them in the pages/ directory.

Also, the root directory of the project should be reserved for just the very basic files, that must be placed.

Yet not supported RAML keys

When running the RAML parser with 'not yet supported' warnings, then the following points reveal as open:

Not yet supported key 'securedBy' at node 'root
Not yet supported key 'securitySchemes' at node 'root
Not yet supported key 'body' at node 'root./shops/{shopId}./carts.post
Not yet supported key 'body' at node 'root./shops/{shopId}./carts./{cartId}./line-items.post
Not yet supported key 'body' at node 'root./shops/{shopId}./carts./{cartId}./line-items./{lineItemId}.put
Not yet supported key 'body' at node 'root./shops/{shopId}./carts./{cartId}./billing-address.put
Not yet supported key 'body' at node 'root./shops/{shopId}./carts./{cartId}./shipping-address.put
Not yet supported key 'body' at node 'root./shops/{shopId}./public-info.post
Not yet supported key 'body' at node 'root./shops/{shopId}./search.post

The support for these should be add in raml_parser.

Implement SEO texts

Please implement SEO texts in API documentation and Developer blog.

API Documentation:

in code:

Keyword: ePages API Documentation (+ Nebenkeywords: ePages API, API documentation)

Title: ePages API Documentation (-> Please use Title in the H1 onsite)

Description: Welcome to the API Documentation of ePages! Here you will find all the resources you need to develop and offer your app successfully to 140,000+ ePages merchants.

Developer blog

in code:

Keywords: ePages developer blog (+ developer blog, ePages dev blog)

Title: ePages Developer Blog (-> Please use Title in the H1 onsite)

Description: Welcome to the ePages Developer Blog! We will give you insights into our daily work, share tech stories and open positions with you and much more.

Search

  • provide a solution for a search, see screen
    bildschirmfoto 2015-02-18 um 13 29 31

Add features for FAQ

Please add features for the FAQ page (categories, links).
This has to be aligned with Lukas

Refactor sitemap linking

Current format:

- key: themes
  title: Themes
  entries:
    - page: themes-getting-started
    - link:
        title: Use cases
        url: '/epages-docs/pages/apps/getting-started.html#use-cases'

Since links can already be written as page:key#hash, we should also align the sitemap so that the example from above would look like this:

- key: themes
  title: Themes
  entries:
    - page: 'themes-getting-started'
    - page: 'apps-getting-started#use-cases'

File location for RAML files

  • discuss topic with team read
    goal would be to have just one "documentation repo" to work from including raml.

Documentation landing page

  • do not display the links to the documentation topics, but only link to the main pages, we have so far, i.e. THEMES, APPS, REST API, SOAP.
  • style the appearance of the main page links, e.g. with boxes, see picture
    anhang 1
  • outsource landing page text

Sorting of text blocks in resources

Currently, the text blocks look like shown in this example:

bildschirmfoto 2015-03-31 um 11 44 05

I would expect it to be like this:

scan_2015-03-31_11-51

I understand the description below displayName as the basic information for this resource. The description for the specific request should follow after the request so that we have a clear visual and logical separation.

Remove API console

@choffmeister Please adapt the style of the API console in epages-docs to the style of the internally used public console. I will send you the link via email accordingly.

Cannot run from Docker locally

docker build -t epages-docs -f Dockerfile.ruby .
An error occurred trying to connect: Post https://192.168.59.103:2376/v1.23/build?buildargs=%7B%7D&cgroupparent=&cpuperiod=0&cpuquota=0&cpusetcpus=&cpusetmems=&cpushares=0&dockerfile=Dockerfile.ruby&labels=%7B%7D&memory=0&memswap=0&rm=1&shmsize=0&t=epages-docs&ulimits=null: dial tcp 192.168.59.103:2376: connectex: A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond.

running on Windows

Structure for resources

  • provide a solution for resource categories, see screen for possible structure
    bildschirmfoto 2015-02-18 um 13 25 28

--> naming convention should be like this: Shop, Product, Order, Customer ...

Site map

  • provide a solution for a multilevel site map

Style/Fonts

  • include ePages font
  • align font sizes according to ePages standard
  • align font size of headlines (from big h1 to small h3 or maybe h4)

Images

  • provide solution to easily link images
  • provide solution to embed images in reasonable sizes

Add a banner "improve this documentation" that leads to here

Quite a lot of documentation sites nowadays have a banner in the top right corner of the page with a "modify this page in github" or something like that.

That makes it clear for documentation consumers on where to create improvements (fixing typos or asking for something to be documented).

Please add something like that in the documentation site.

Snipped gadget

  • provide solution to easily link content that will be frequently repeated

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.