appsody / website

Appsody website and documentation. This repo will be archived soon.
https://appsody.dev
Apache License 2.0
13 stars 29 forks source link

Create a prototype Glossary page #282

Closed helenmasters closed 4 years ago

helenmasters commented 4 years ago

The task here is to design and create a prototype Glossary page which can then be populated with words and associated definitions from #272.

KyeMaloy97 commented 4 years ago

The page has been made, but is waiting on the definitions to be written up by Helen and David.

helenmasters commented 4 years ago

Kye, below are the first set of agreed definitions for the Markdown file:

Appsody CLI

The Appsody command-line interface supports the full application development lifecycle; creating stacks, creating applications based on stacks, testing and debugging your applications, and deployment to Kubernetes.

Project template

Project templates provide a starting point, typically a 'Hello World' application, for application development. Like other components within an Appsody stack, you can customize project templates and share them across teams.

helenmasters commented 4 years ago

A second set which may require minor tweaks:

Dockerfile

Dockerfile combines your application and the stack to build a production image, ready for deployment. For more information on Dockerfiles see the official Docker documentation.

Dockerfile-stack

Dockerfile-stack is a Dockerfile that builds a stack container image used during development. For more information on Dockerfiles see the official Docker documentation.

KyeMaloy97 commented 4 years ago

Currently working on recreating this page, have successfully added MDX support to the website which is future proofing and learning how to make the components as easy as possible to add to (so new definitions are easy to put in and require no advanced knowledge).

KyeMaloy97 commented 4 years ago

Have a working version, which allows you to write all of the code in Markdown :)

Screenshot 2019-12-03 at 12 41 35

Here is an alternative option, which basically uses the same style as our blockquotes. Opinions on what is better would be great.

Screenshot 2019-12-03 at 12 43 22
SueChaplain commented 4 years ago

I like the pink one! ... but also like the rounded edges of the top one! Mix and match maybe?!

KyeMaloy97 commented 4 years ago

All the corners rounded or just the ones on the right? If you round all the corners the left border gets cut off at the top and bottom like this:

All Rounded Corners

Screenshot 2019-12-03 at 13 03 50

This is how it looks with the left corners squared off:

Square Corners

Screenshot 2019-12-03 at 13 04 27
helenmasters commented 4 years ago

I prefer the design of A and the colours of B. The bit I like on A is the curved box design rather than the pink bar on the left, the bit I like on B is the background pink colour.

KyeMaloy97 commented 4 years ago

Okay, well here it is with the colours but rounded:

Colours and Rounded

Screenshot 2019-12-03 at 13 32 22

and here it is with more of a boxy shape, and the thicker border on the side:

Boxier with thick border

Screenshot 2019-12-03 at 13 28 28

and finally boxier with no extra borders, very similar to a blockquote though:

Boxier with thick left border and no extra borders

Screenshot 2019-12-03 at 13 21 45
SueChaplain commented 4 years ago

I like colours and rounded best, but they all look pretty good!

KyeMaloy97 commented 4 years ago

PR is open, however the CLI reference is broken if we merge at the moment due to their variables looking like React elements, and therefore MDX (also introduced in this PR) gets upset and refuses to render the page. Raised an issue in Appsody (https://github.com/appsody/appsody/issues/761).