search

giantswarm / docs

The Giant Swarm documentation site
http://docs.giantswarm.io
Apache License 2.0
4 stars 8 forks source link

docs: Spec: Think about which company should be used in examples #50

Closed teemow closed 9 years ago

teemow commented 9 years ago

Currently often giantswarm is used as company in the docs. TBD how problematic this is. And wether a different company makes it clearer for the user.

Original Author: @luebken Created at 24-11-2014 15:48:46 Gitlab: giantswarm/docs!6

teemow commented 9 years ago

@luebken commented:

Idea from @marian acmeinc

Created at 24-11-2014 15:49:19

teemow commented 9 years ago

@marian commented:

I see a point in using something than can be easily understood as an example company name.

More suggestions:

Created at 24-11-2014 15:52:46

teemow commented 9 years ago

@puja commented:

especially something that is coherent over all docs and examples, so we have one single way of naming stuff

Created at 24-11-2014 15:54:26

teemow commented 9 years ago

@puja commented:

any preferences @luebken?

Created at 10-12-2014 10:21:56

teemow commented 9 years ago

@luebken commented:

I am not happy with this approach.

Reasoning: a different company would only make it more apparent to the user. But if they copy and paste the examples and clone Github repos they would still run into errors.

Currently more thinking if we can build more variable examples. Especially once https://git.giantswarm.io/giantswarm/cli/issues/173 is implemented.

Created at 10-12-2014 15:21:24

teemow commented 9 years ago

@puja commented:

Yeah, we seem to have a general problem with people not thinking enough and just copy pasting stuff. Not their fault, but ours.

Created at 10-12-2014 15:36:32

teemow commented 9 years ago

@marian commented:

As @luebken pointed out, this discussion also applies to example user names.

I just hat a look at the Skylanders website (the video game where "Swarm", one of their Giant characters is from). They have some more "Giant" characters in several categories.

fire
    hothead
    lightcore_eruptor
    hotdog
    series2ignitor
    series2eruptor
    series2flameslinger
water
    thumpback
    lightcore_chill
    chill
    series2slambam
    series2zap
    series2gillgrunt
earth
    crusher
    lightcore_prism_break
    flashwing
    series2terrafin
    series2bash
    series2prismbreak
life
    treerex
    lightcore_shroomboom
    shroomboom
    series2stealthelf
    series2zook
    series2stumpsmash
air
    swarm
    lightcore_jetvac
    jetvac
    series2sonicboom
    series2whirlwind
    series2lightningrod
tech
    bouncer
    lightcore_drobot
    sprocket
    series2drillsergeant
    series2triggerhappy
    series2drobot
magic
    ninjini
    lightcore_popfizz
    popfizz
    series2wreckingball
    series2spyro
    series2doubletrouble
undead
    eyebrawl
    lightcore_hex
    fright_rider
    series2cynder
    series2chopchop
    series2hex

Created at 15-12-2014 09:53:21

luebken commented 9 years ago

we are currently using yourusername seems good enough for me