Find solution to automatically include the raml.file content changes into epages-docs

We have to choose one of the creative common licenses from here. My favorite is:

https://creativecommons.org/licenses/by-nc-sa/4.0/

@netzfisch Could you look on the overview page of my favorite and tell, if it is what you had in mind?

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

Please fix this:

1. abc
2. def
3. yuz
   Callout/Picture
   1.
   2.

to this:

1. abc
2. def
3. xuz
   Callout/Picture
4. uuu
5. iii

@choffmeister Please explain how to deploy live in case an issue has to be made available on short notice and cannot wait for being deployed automatically.

Please add code snippets to the REST resources.
See example for cURL: https://support.dudamobile.com/API/REST-Resources/Permission_Groups

To be decided if to be automated or done manually.

@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.

Colorise the HTTP verbs on the resource overview.

Follow up of #4.

Removed

Please provide a solution to display different example code in order to provide it in the documentation, e.g. for JavaScript, Ruby, PHP.

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

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

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.

• provide a solution for a multilevel site map

@lkoeln If the text is far too long we need a top button or the sidebar following the text.

@choffmeister In the section Share of every blog post, please exchange the text Twitter, Facebook, Google+ with the respective social media icons. You can use the icons and their respective size from the epages blog: http://blog.epages.com/us/?utm_source=ePages&utm_medium=Menu%20Entry&utm_campaign=website.

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

SALES asked for a proper webservices documentation, as the open SOAP is by far the biggest USP for our Flex.
For the current documentation there's already a tool in place:
https://bintray.com/artifact/download/epages/maven/de.epages.soapclient-documentation/1.4.16/de.epages.soapclient-documentation-1.4.16.zip
@choffmeister: Is it possible to integrate this into epages-docs? Please give a feedback on how much effort this would be.

Please establish blog features for the Developer Blog.

• provide a solution for a search, see screen
  

@choffmeister It would be nice, if we could already display the icon of the blog post in the excerpt on the index page. Please check if that fits and looks nicely. Thanks.

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.

@choffmeister To distinguish between development and live version of epages-docs, please create a master-branch. This way, I can work against the development-branch directly and if specific content should go live, this can be done via the master-branch.

@choffmeister

... to developer.epages.com

@choffmeister create option to have several raml routes

Please include a bar of letters at the top of the page with each letter at the top linked to the respective section. As an example, refer to this: http://europa.eu/legislation_summaries/glossary/

Please adapt the header for the 1&1 provisioning docu.
We also need a separate "start page".

@choffmeister please include a banderole for the documentation, stating, that this is beta

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.

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

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.

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'

align http verbs with resources e.g. in two columns so that look and feel "looks tidy"

Is this still the case? I see much more posts in develop.

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

Our available resources come as a list in the sidebar navigation.
Currently it looks like this:

But it should look like this:

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

I would expect it to be like this:

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.

... to be included.
See invision flow:
https://projects.invisionapp.com/share/V91ZV33HA#/screens/57250230?maintainScrollPosition=false

only navigation for Documentation required that links to Documentation landing page for App Development

• 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
  
• outsource landing page text

• provide a solution for resource categories, see screen for possible structure
  

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

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

In the webhooks section it would be good to document the retry policy for the webhook delivery.

https://developer.epages.com/beyond-docs/#order_events_callback