Smalltalk › Amber Smalltalk

Amber docs review. Tell us what you want to see!

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

18 messages Options

sebastianconcept

Amber docs review. Tell us what you want to see!

Hi guys,

After hearing people unnecessarily struggling to get things done in Amber I’m currently reviewing the information architecture of Amber docs site, it has many problems and I’m trying to address some of them.

The opinions that we are currently seeking the most now are the ones coming from people that is NOT among the Amber contributors team.

So please speak up! Your voice matters to make this right!

1. What you guys think about this menu at the left?

2. What questions you expect answered in the FAQ?

3. What How-To do you want to see there?

If you are from the Amber team is okay to answer too but you should expect to be ignored unless you say something really representative to a wider audience.

Thanks!

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.

Amber Smalltalk mailing list

Re: Amber docs review. Tell us what you want to see!

Hi Sebastian,

thank you for the effort!

Well,... I would love to see the following topics: withouf taking care
if it is already included

- amber server apps
- amber client apps
- using amber apps/libs in "native js apps"
- hosting/deploying amber apps (which servers work and how)
- workflow description on how bower, grunt and package.json play together.
- list of supported framworks for the current release (which amber
plugin/extension is considered stable)
- list of dev tool suggestions (browser plugins / editors)
- how to make a desktop app with the current release
- does and don'ts if a app/lib needs to be server-able and client-able
- explanation of the file directory structure.
- How to use Helios (debugging, short cuts, ... )
- links to suggested educational sites ( using bower, using npm, using
require, ... )
- hints and tips on stuff one always stumbles across ( using
NativeFunction, where to store initialized js objects (Dom or instance
variables), event/announcements handling/triggering, ... ).
- conventions (code, versioning)
- list of currently supportet sources (code repository, documentation,
newslists, forums, chats) ("this might help to spot active community and
sources and more prototypical/depricable resources...")
- History of Amber and the intension behind it.
- Hints / tips on proofed to be good backends/middletiers for Amber.
- use cases / show cases of Amber (project size, status, age)
- Roadmap or current focus

It is not all necessarily documentation stuff, but things that might
always be of general interest and should help to start with Amber.

Sebastian

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.

Craig Latta-2

Re: Amber docs review. Tell us what you want to see!

In reply to this post by sebastianconcept

Hoi Sebastian--

Looks good... I'm particularly interested in the content for the sections on "Integrating JavaScript Libraries" and "Build and Deploy".

thanks!

-C

Craig Latta

http://thiscontext.com

sebastianconcept

Re: Amber docs review. Tell us what you want to see!

In reply to this post by Amber Smalltalk mailing list

This is a great response! Thanks Sebastian!

Many great questions and some weird ones :)))

I’ve loved the one about wrapping html5 as “native" apps :)

I ask you to elaborate or contextualize on some others below..

> On Jan 9, 2015, at 3:44 PM, 'Sebastian Heidbrink' via amber-lang <[hidden email]> wrote:
>
> Hi Sebastian,
>
> thank you for the effort!
>
> Well,... I would love to see the following topics: withouf taking care if it is already included
>
> - amber server apps
> - amber client apps
> - using amber apps/libs in "native js apps”

what do you mean amber apps vs. native js apps? what do you want to compare or see coming out from this? speed? something else? what?

> - hosting/deploying amber apps (which servers work and how)
> - workflow description on how bower, grunt and package.json play together.
> - list of supported framworks for the current release (which amber plugin/extension is considered stable)
The Amber team supports Amber, what do you mean by supported frameworks?

> - list of dev tool suggestions (browser plugins / editors)
> - how to make a desktop app with the current release
> - does and don'ts if a app/lib needs to be server-able and client-able
What do you mean here?

> - explanation of the file directory structure.
> - How to use Helios (debugging, short cuts, ... )
> - links to suggested educational sites ( using bower, using npm, using require, ... )
> - hints and tips on stuff one always stumbles across ( using NativeFunction, where to store initialized js objects (Dom or instance variables), event/announcements handling/triggering, ... ).
Can you care to elaborate as concrete and complete questions on those subjects? Thanks!

> - conventions (code, versioning)
about code conventions, you want to see the docs talking about smalltalk style? or your question is something else? can you rephrase?
about version, you mean versioning in bower.json?

> - list of currently supportet sources (code repository, documentation, newslists, forums, chats) ("this might help to spot active community and sources and more prototypical/depricable resources...")
> - History of Amber and the intension behind it.
> - Hints / tips on proofed to be good backends/middletiers for Amber.
> - use cases / show cases of Amber (project size, status, age)
> - Roadmap or current focus
>
>
> It is not all necessarily documentation stuff, but things that might always be of general interest and should help to start with Amber.
>
> Sebastian
>
>
> --
> You received this message because you are subscribed to the Google Groups "amber-lang" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
> For more options, visit https://groups.google.com/d/optout.

sebastianconcept

Re: Amber docs review. Tell us what you want to see!

In reply to this post by Amber Smalltalk mailing list

As a follow up of this effort, I’ve made this editorial pipeline to get Amber’s documentation sorted out.

Sounds like a lot of work but I think is pretty doable.

Please join to be among the authors and reviewers:

https://trello.com/b/PDYympel/amber-documentation

It will be curated so expect to be heavily reviewed.

The more people joins and help there the faster we can produce quality docs

Have in mind that better the docs will help in:

- SEO (positioning in search engines)

- showing that valuable problems can be solved fast with this technology

- show we have strong communication skills

- show we have strong technical skills

- show that a good programmer that tries smalltalk can get shit done fast

- show this is not “a toy"

Let the ball drop and everything will go down

Make it happen and you will be fabricating your luck

I’ve started.

Lets do this?

On Jan 9, 2015, at 3:44 PM, 'Sebastian Heidbrink' via amber-lang <[hidden email]> wrote:

Hi Sebastian,

thank you for the effort!

Amber Smalltalk mailing list

Re: Amber docs review. Tell us what you want to see!

In reply to this post by sebastianconcept

:-D

""""I’ve loved the one about wrapping html5 as “native" apps :) """

- Thanks.
- Well "Integrating Amber in JavaScript Libraries and Apps".... "The
evil way around..."

"""The Amber team supports Amber, what do you mean by supported frameworks?"""

- Hmmm better say considered stable. Are there amber extensions the
Amber team would suggest to have a look at.
flow-stack, marina, tide, ludus... which of those are still maintained
and good show cases.
Can you currently tell which HTTP Server or web framework is considered
a good starting point?
I lost track!
That's how a beginner will feel. A lot of frustration...

"""does and don'ts if a app/lib needs to be server-able and client-able"""

- I learnt yesterday that there are some omlmentation that one should
not use, if you would like to use code on the server side too.
anObjectat: #allowJavastripCalls put: true needs to be Smalltalk optOut:
anObject
Simply things not so obvious...

""" hints and tips on stuff one always stumbles across ( using NativeFunction, where to store initialized js objects (Dom or instance variables), event/announcements handling/triggering, ... )."""

- Answers to questions like: how can I signal events and react on them?
How do I integrate JavaScript Libraries and use NativeFunction! Is there
a announcements framework? How do I define callbacks? Tips on logging
and debugging.

""" about code conventions, you want to see the docs talking about
smalltalk style? or your question is something else? can you rephrase?
about version, you mean versioning in bower.json? """
- No general smalltak style hints, but, maybe an insight on how the core
team does it. This way we might keep a more consistent code base. Thinks
like. When to use Symbols and when Strings. always or never write
accessors.
- Exactly what are the rules of versioning in the amber core
packages/libraries. What kind of changes is considered a minor and what
a major release.

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.

Herby Vojčík

Re: Amber docs review. Tell us what you want to see!

'Sebastian Heidbrink' via amber-lang wrote:
> """does and don'ts if a app/lib needs to be server-able and
> client-able"""
>
> - I learnt yesterday that there are some omlmentation that one should
> not use, if you would like to use code on the server side too.
> anObjectat: #allowJavastripCalls put: true needs to be Smalltalk
> optOut: anObject
> Simply things not so obvious...

No, not that. That is agnostic. You need not to use window and document globals if you want to be executable on the server-side as well.

> """ hints and tips on stuff one always stumbles across ( using
> NativeFunction, where to store initialized js objects (Dom or instance
> variables), event/announcements handling/triggering, ... )."""
>
> - Answers to questions like: how can I signal events and react on
> them? How do I integrate JavaScript Libraries and use NativeFunction!

You don't use NativeFunction. Unless you happen over very special case when there is a JS function which for some
reason happens not to be caught by Amber under BlockClosure umbrella. There is very little such cases. So little you should not care for the moment.

> Is there a announcements framework? How do I define callbacks? Tips on

Any block in Smalltalk is a function in JS. Look for the code of AmberCli (in Amber itself) and you see callbacks used with node api.

> - Exactly what are the rules of versioning in the amber core
> packages/libraries. What kind of changes is considered a minor and
> what a major release.

There wasn't any major release yet. I try to go as specified in semver. So update x of 0.x.y when there is a breaking change and update y if not.

Herby

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.

Amber Smalltalk mailing list

Re: Amber docs review. Tell us what you want to see!

Hi Herby,

we where talking about content for the documentation site and things
that should be interesting for Amber developers...

But thank you for your feedback ;-)

Have a great weekend!
Sebastian

Am 09.01.2015 um 13:20 schrieb Herby Vojčík:

>
>
> 'Sebastian Heidbrink' via amber-lang wrote:
>> """does and don'ts if a app/lib needs to be server-able and
>> client-able"""
>>
>> - I learnt yesterday that there are some omlmentation that one should
>> not use, if you would like to use code on the server side too.
>> anObjectat: #allowJavastripCalls put: true needs to be Smalltalk
>> optOut: anObject
>> Simply things not so obvious...
>
> No, not that. That is agnostic. You need not to use window and
> document globals if you want to be executable on the server-side as well.
>
>> """ hints and tips on stuff one always stumbles across ( using
>> NativeFunction, where to store initialized js objects (Dom or
>> instance variables), event/announcements handling/triggering, ... )."""
>>
>> - Answers to questions like: how can I signal events and react on
>> them? How do I integrate JavaScript Libraries and use NativeFunction!
>
> You don't use NativeFunction. Unless you happen over very special case
> when there is a JS function which for some
> reason happens not to be caught by Amber under BlockClosure umbrella.
> There is very little such cases. So little you should not care for the
> moment.
>
>> Is there a announcements framework? How do I define callbacks? Tips on
>
> Any block in Smalltalk is a function in JS. Look for the code of
> AmberCli (in Amber itself) and you see callbacks used with node api.
>
>> - Exactly what are the rules of versioning in the amber core
>> packages/libraries. What kind of changes is considered a minor and
>> what a major release.
>
> There wasn't any major release yet. I try to go as specified in
> semver. So update x of 0.x.y when there is a breaking change and
> update y if not.
>
> Herby
>

sebastianconcept

Re: Amber docs review. Tell us what you want to see!

yes, thanks Sebastian for the elaboration

Herby you can copy paste your answers on that couple of questions and put them in the corresponding trello card?

Trello should allow you to add cards if needed

For anyone wanting to add cards there, the rule is simple, we start always at the left column and it will eventually get pushed to the right by the team process

Thanks!

sebastian

o/

> On 09/01/2015, at 19:26, 'Sebastian Heidbrink' via amber-lang <[hidden email]> wrote:
>
> Hi Herby,
>
>
> we where talking about content for the documentation site and things that should be interesting for Amber developers...
>
> But thank you for your feedback ;-)
>
> Have a great weekend!
> Sebastian
>
>
>
>
>> Am 09.01.2015 um 13:20 schrieb Herby Vojčík:
>>
>>
>> 'Sebastian Heidbrink' via amber-lang wrote:
>>> """does and don'ts if a app/lib needs to be server-able and client-able"""
>>>
>>> - I learnt yesterday that there are some omlmentation that one should not use, if you would like to use code on the server side too.
>>> anObjectat: #allowJavastripCalls put: true needs to be Smalltalk optOut: anObject
>>> Simply things not so obvious...
>>
>> No, not that. That is agnostic. You need not to use window and document globals if you want to be executable on the server-side as well.
>>
>>> """ hints and tips on stuff one always stumbles across ( using NativeFunction, where to store initialized js objects (Dom or instance variables), event/announcements handling/triggering, ... )."""
>>>
>>> - Answers to questions like: how can I signal events and react on them? How do I integrate JavaScript Libraries and use NativeFunction!
>>
>> You don't use NativeFunction. Unless you happen over very special case when there is a JS function which for some
>> reason happens not to be caught by Amber under BlockClosure umbrella. There is very little such cases. So little you should not care for the moment.
>>
>>> Is there a announcements framework? How do I define callbacks? Tips on
>>
>> Any block in Smalltalk is a function in JS. Look for the code of AmberCli (in Amber itself) and you see callbacks used with node api.
>>
>>> - Exactly what are the rules of versioning in the amber core packages/libraries. What kind of changes is considered a minor and what a major release.
>>
>> There wasn't any major release yet. I try to go as specified in semver. So update x of 0.x.y when there is a breaking change and update y if not.
>>
>> Herby
>
> --
> You received this message because you are subscribed to the Google Groups "amber-lang" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
> For more options, visit https://groups.google.com/d/optout.

Herby Vojčík

Re: Amber docs review. Tell us what you want to see!

IIRC I wasn't able to add cards.

sebastian wrote:

> yes, thanks Sebastian for the elaboration
>
> Herby you can copy paste your answers on that couple of questions and put them in the corresponding trello card?
>
> Trello should allow you to add cards if needed
>
> For anyone wanting to add cards there, the rule is simple, we start always at the left column and it will eventually get pushed to the right by the team process
>
> Thanks!
>
> sebastian
>
> o/
>
>> On 09/01/2015, at 19:26, 'Sebastian Heidbrink' via amber-lang<[hidden email]> wrote:
>>
>> Hi Herby,
>>
>>
>> we where talking about content for the documentation site and things that should be interesting for Amber developers...
>>
>> But thank you for your feedback ;-)
>>
>> Have a great weekend!
>> Sebastian
>>
>>
>>
>>
>>> Am 09.01.2015 um 13:20 schrieb Herby Vojčík:
>>>
>>>
>>> 'Sebastian Heidbrink' via amber-lang wrote:
>>>> """does and don'ts if a app/lib needs to be server-able and client-able""

>>>>
>>>> - I learnt yesterday that there are some omlmentation that one should not use, if you would like to use code on the server side too.
>>>> anObjectat: #allowJavastripCalls put: true needs to be Smalltalk optOut: anObject
>>>> Simply things not so obvious...
>>> No, not that. That is agnostic. You need not to use window and document globals if you want to be executable on the server-side as well.
>>>
>>>> """ hints and tips on stuff one always stumbles across ( using NativeFunction, where to store initialized js objects (Dom or instance variables), event/announcements handling/triggering, ... )."""
>>>>
>>>> - Answers to questions like: how can I signal events and react on them? How do I integrate JavaScript Libraries and use NativeFunction!
>>> You don't use NativeFunction. Unless you happen over very special case when there is a JS function which for some
>>> reason happens not to be caught by Amber under BlockClosure umbrella. There is very little such cases. So

little you should not care for the moment.

>>>
>>>> Is there a announcements framework? How do I define callbacks? Tips on
>>> Any block in Smalltalk is a function in JS. Look for the code of AmberCli (in Amber itself) and you see callbacks used with node api.
>>>
>>>> - Exactly what are the rules of versioning in the amber core packages/libraries. What kind of changes is considered a minor and what a major release.
>>> There wasn't any major release yet. I try to go as specified in semver. So update x of 0.x.y when there is a breaking change and update y if not.
>>>
>>> Herby
>> --
>> You received this message because you are subscribed to the Google Groups "amber-lang" group.
>> To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
>> For more options, visit https://groups.google.com/d/optout.
>

sebastianconcept

Re: Amber docs review. Tell us what you want to see!

I've added your user to that trello board

I think you can now, could you please retry?

sebastian

o/

> On 10/01/2015, at 15:03, Herby Vojčík <[hidden email]> wrote:
>
> IIRC I wasn't able to add cards.
>
> sebastian wrote:
>> yes, thanks Sebastian for the elaboration
>>
>> Herby you can copy paste your answers on that couple of questions and put them in the corresponding trello card?
>>
>> Trello should allow you to add cards if needed
>>
>> For anyone wanting to add cards there, the rule is simple, we start always at the left column and it will eventually get pushed to the right by the team process
>>
>> Thanks!
>>
>> sebastian
>>
>> o/
>>
>>> On 09/01/2015, at 19:26, 'Sebastian Heidbrink' via amber-lang<[hidden email]> wrote:
>>>
>>> Hi Herby,
>>>
>>>
>>> we where talking about content for the documentation site and things that should be interesting for Amber developers...
>>>
>>> But thank you for your feedback ;-)
>>>
>>> Have a great weekend!
>>> Sebastian
>>>
>>>
>>>
>>>
>>>> Am 09.01.2015 um 13:20 schrieb Herby Vojčík:
>>>>
>>>>
>>>> 'Sebastian Heidbrink' via amber-lang wrote:
>>>>> """does and don'ts if a app/lib needs to be server-able and client-able""
> "
>>>>>
>>>>> - I learnt yesterday that there are some omlmentation that one should not use, if you would like to use code on the server side too.
>>>>> anObjectat: #allowJavastripCalls put: true needs to be Smalltalk optOut: anObject
>>>>> Simply things not so obvious...
>>>> No, not that. That is agnostic. You need not to use window and document globals if you want to be executable on the server-side as well.
>>>>
>>>>> """ hints and tips on stuff one always stumbles across ( using NativeFunction, where to store initialized js objects (Dom or instance variables), event/announcements handling/triggering, ... )."""
>>>>>
>>>>> - Answers to questions like: how can I signal events and react on them? How do I integrate JavaScript Libraries and use NativeFunction!
>>>> You don't use NativeFunction. Unless you happen over very special case when there is a JS function which for some
>>>> reason happens not to be caught by Amber under BlockClosure umbrella. There is very little such cases. So
> little you should not care for the moment.
>>>>
>>>>> Is there a announcements framework? How do I define callbacks? Tips on
>>>> Any block in Smalltalk is a function in JS. Look for the code of AmberCli (in Amber itself) and you see callbacks used with node api.
>>>>
>>>>> - Exactly what are the rules of versioning in the amber core packages/libraries. What kind of changes is considered a minor and what a major release.
>>>> There wasn't any major release yet. I try to go as specified in semver. So update x of 0.x.y when there is a breaking change and update y if not.
>>>>
>>>> Herby
>>> --
>>> You received this message because you are subscribed to the Google Groups "amber-lang" group.
>>> To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
>>> For more options, visit https://groups.google.com/d/optout.
>
> --
> You received this message because you are subscribed to the Google Groups "amber-lang" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
> For more options, visit https://groups.google.com/d/optout.

Herby Vojčík

Re: Amber docs review. Tell us what you want to see!

Yes it shows the possibiity now.

sebastian wrote:

> I've added your user to that trello board
>
> I think you can now, could you please retry?
>
> sebastian
>
> o/
>
>> On 10/01/2015, at 15:03, Herby Vojčík<[hidden email]> wrote:
>>
>> IIRC I wasn't able to add cards.
>>
>> sebastian wrote:
>>> yes, thanks Sebastian for the elaboration
>>>
>>> Herby you can copy paste your answers on that couple of questions and put them in the corresponding trello card?
>>>
>>> Trello should allow you to add cards if needed
>>>
>>> For anyone wanting to add cards there, the rule is simple, we start always at the left column and it will eventually get pushed to the right by the team process
>>>
>>> Thanks!
>>>
>>> sebastian
>>>
>>> o/
>>>
>>>> On 09/01/2015, at 19:26, 'Sebastian Heidbrink' via amber-lang<[hidden email]> wrote:
>>>>
>>>> Hi Herby,
>>>>
>>>>
>>>> we where talking about content for the documentation site and things that should be interesting for Amber develo

pers...

>>>>
>>>> But thank you for your feedback ;-)
>>>>
>>>> Have a great weekend!
>>>> Sebastian
>>>>
>>>>
>>>>
>>>>
>>>>> Am 09.01.2015 um 13:20 schrieb Herby Vojčík:
>>>>>
>>>>>
>>>>> 'Sebastian Heidbrink' via amber-lang wrote:
>>>>>> """does and don'ts if a app/lib needs to be server-able and client-able""
>> "
>>>>>> - I learnt yesterday that there are some omlmentation that one should not use, if you would like to use code on the server side too.
>>>>>> anObjectat: #allowJavastripCalls put: true needs to be Smalltalk optOut: anObject
>>>>>> Simply things not so obvious...
>>>>> No, not that. That is agnostic. You need not to use window and document globals if you want to be executable on the server-side as well.
>>>>>
>>>>>> """ hints and tips on stuff one always stumbles across ( using NativeFunction, where to store initialized js objects (Dom or instance variables), event/announcements handling/triggering, ... )."""
>>>>>>
>>>>>> - Answers to questions like: how

can I signal events and react on them? How do I integrate JavaScript Libraries and use NativeFunction!

>>>>> You don't use NativeFunction. Unless you happen over very special case when there is a JS function which for some
>>>>> reason happens not to be caught by Amber under BlockClosure umbrella. There is very little such cases. So
>> little you should not care for the moment.
>>>>>> Is there a announcements framework? How do I define callbacks? Tips on
>>>>> Any block in Smalltalk is a function in JS. Look for the code of AmberCli (in Amber itself) and you see callbacks used with node api.
>>>>>
>>>>>> - Exactly what are the rules of versioning in the amber core packages/libraries. What kind of changes is considered a minor and what a major release.
>>>>> There wasn't any major release yet. I try to go as specified in semver. So update x of 0.x.y when there is a breaking change and update y if not.
>>>>>
>>>>> Herby
>>>> --
>>>> You received this message because you are s

ubscribed to the Google Groups "amber-lang" group.
>>>> To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
>>>> For more options, visit https://groups.google.com/d/optout.
>> --
>> You received this message because you are subscribed to the Google Groups "amber-lang" group.
>> To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
>> For more options, visit https://groups.google.com/d/optout.
>

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.

sebastianconcept

Re: Amber docs review. Tell us what you want to see!

In reply to this post by sebastianconcept

A follow up on this.

I've invited some folks to join the effort of having these basic how-tos done for Amber and I'm surprised by the response it had.

~24hs later and we have already a task-force of 8 folks to help on this!

And others might also respond in the next hours/days.

Anyway I wanted to say thanks to all who have take action on this. We are about to remove a ton of terrible karma once we deliver.

I'll gently pull the contributors to write and review parts so we can deliver what's important first.

Expect to have fun using the guides to tell to new kids how they can do cool tricks with Amber!

On Friday, January 9, 2015 at 2:19:37 PM UTC-2, Sebastian Sastre wrote:

Hi guys,

After hearing people unnecessarily struggling to get things done in Amber I’m currently reviewing the information architecture of Amber docs site, it has many problems and I’m trying to address some of them.

The opinions that we are currently seeking the most now are the ones coming from people that is NOT among the Amber contributors team.

So please speak up! Your voice matters to make this right!

1. What you guys think about this menu at the left?
2. What questions you expect answered in the FAQ?
3. What How-To do you want to see there?

If you are from the Amber team is okay to answer too but you should expect to be ignored unless you say something really representative to a wider audience.

Thanks!

jtuchel

Re: Amber docs review. Tell us what you want to see!

In reply to this post by sebastianconcept

Hi,

I just invested about 30 minutes and I must say I liked the new site and the installation process. I remember trying in the past and more than once I gave up because it was quite complicated.

Now that I have Amber running, there are a few questions that I would like to see answered in the documentation:

* If I wanted to use bootstrap or the like, how would I pull these into my project? I guess the bootstrap that is in the path I created with Amber init is not the one I should actually use for my project, right?

* in what directory would I call git init what should my .gitignore look like? I mean, what do I put under version control, and what can be reconstructed from scratch? In the end, I just want my html and .st files and maybe some js libs in the repository, not amber nor the IDE, right?

* How would I recreate the project path using Amber for the things that are not under version control and merge my Amber stuff from git into it? This can be used to cooperate with other developers, or for purposes

* I'd like to see a short description of what the actual questions of amber init mean and where my answers end up. How can I change things later if my package name is misspelled or I didn't enter a git repository in the first place.

* I am quite sure this is documented somewhere (else): how do I add more packages to my project later.

Joachim

Am Freitag, 9. Januar 2015 17:19:37 UTC+1 schrieb Sebastian Sastre:

Hi guys,

After hearing people unnecessarily struggling to get things done in Amber I’m currently reviewing the information architecture of Amber docs site, it has many problems and I’m trying to address some of them.

The opinions that we are currently seeking the most now are the ones coming from people that is NOT among the Amber contributors team.

So please speak up! Your voice matters to make this right!

1. What you guys think about this menu at the left?
2. What questions you expect answered in the FAQ?
3. What How-To do you want to see there?

If you are from the Amber team is okay to answer too but you should expect to be ignored unless you say something really representative to a wider audience.

Thanks!

Herby Vojčík

Re: Amber docs review. Tell us what you want to see!

In reply to this post by sebastianconcept

Joachim Tuchel <[hidden email]>napísal/a:

* in what directory would I call git init what should my .gitignore look like? I mean, what do I put under version control, and what can be reconstructed from scratch? In the end, I just want my html and .st files and maybe some js libs in the repository, not amber nor the IDE, right?

I'd recommend you go the easy way and use the .gitignore that is precreated by your `amber init`. It does good job.

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.

jtuchel

Re: Amber docs review. Tell us what you want to see!

As a dumb mac user, I didn't see there is a .gitignore!

So I'll study it and see if it fits with my expectations or what I can learn from it.

So there remains the question of how I could recreate a project on another machine, like, say, a co-developer of mine would use it to pull in the project's code. Maybe taking a closer look at the .gitignore file can shed some light on this...

Joachim

Am Sonntag, 11. Januar 2015 13:07:07 UTC+1 schrieb Herby:

Joachim Tuchel <<a href="javascript:" target="_blank" gdf-obfuscated-mailto="EZsqqtXyj_QJ" onmousedown="this.href='javascript:';return true;" onclick="this.href='javascript:';return true;">jtu...@...>napísal/a:
* in what directory would I call git init what should my .gitignore look like? I mean, what do I put under version control, and what can be reconstructed from scratch? In the end, I just want my html and .st files and maybe some js libs in the repository, not amber nor the IDE, right?
I'd recommend you go the easy way and use the .gitignore that is precreated by your `amber init`. It does good job.

Herby Vojčík

Re: Amber docs review. Tell us what you want to see!

Just clone it and do what's told in README to rejuvenate (npm install, bower install, grunt devel).

Joachim Tuchel wrote:

> As a dumb mac user, I didn't see there is a .gitignore!
>
> So I'll study it and see if it fits with my expectations or what I can
> learn from it.
>
> So there remains the question of how I could recreate a project on
> another machine, like, say, a co-developer of mine would use it to
> pull in the project's code. Maybe taking a closer look at the
> .gitignore file can shed some light on this...
>
> Joachim
>
>
>
> Am Sonntag, 11. Januar 2015 13:07:07 UTC+1 schrieb Herby:
>
> Joachim Tuchel <[hidden email] <javascript:>>napísal/a:
>
> * in what directory would I call git init what should my
> .gitignore look like? I mean, what do I put under version control,
> and what can be reconstructed from scratch? In the end, I just
> want my html and .st files and maybe some js libs in the
> repository, not amber nor the IDE

, right?

>
> I'd recommend you go the easy way and use the .gitignore that is
> precreated by your `amber init`. It does good job.
>
> --
> You received this message because you are subscribed to the Google
> Groups "amber-lang" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to [hidden email]
> <mailto:[hidden email]>.
> For more options, visit https://groups.google.com/d/optout.

sebastianconcept

Re: Amber docs review. Tell us what you want to see!

In reply to this post by jtuchel

Fantastic questions Joachim!

I’ve added them all to be answered in our FAQ except the one about bootstrap that is going to be a short how-to

You asked many things there that are almost sub-conscious for the expert and probeble roadblocks for who want to try Amber in a hurry

Thank you for sending them!

docs-team, please feel free to author an answer! if you want to answer one, please take the one you like (the FAQ cards are labelled in blue), push them to the ‘Doing’ column and add a link to a google doc with your text

We’ll continue the process from there until publishing

On Jan 11, 2015, at 7:02 AM, Joachim Tuchel <[hidden email]> wrote:

Hi,

I just invested about 30 minutes and I must say I liked the new site and the installation process. I remember trying in the past and more than once I gave up because it was quite complicated.

Now that I have Amber running, there are a few questions that I would like to see answered in the documentation:

* If I wanted to use bootstrap or the like, how would I pull these into my project? I guess the bootstrap that is in the path I created with Amber init is not the one I should actually use for my project, right?

* in what directory would I call git init what should my .gitignore look like? I mean, what do I put under version control, and what can be reconstructed from scratch? In the end, I just want my html and .st files and maybe some js libs in the repository, not amber nor the IDE, right?

* How would I recreate the project path using Amber for the things that are not under version control and merge my Amber stuff from git into it? This can be used to cooperate with other developers, or for purposes

* I'd like to see a short description of what the actual questions of amber init mean and where my answers end up. How can I change things later if my package name is misspelled or I didn't enter a git repository in the first place.

* I am quite sure this is documented somewhere (else): how do I add more packages to my project later.

Joachim

Am Freitag, 9. Januar 2015 17:19:37 UTC+1 schrieb Sebastian Sastre:
Hi guys,

After hearing people unnecessarily struggling to get things done in Amber I’m currently reviewing the information architecture of Amber docs site, it has many problems and I’m trying to address some of them.

The opinions that we are currently seeking the most now are the ones coming from people that is NOT among the Amber contributors team.

So please speak up! Your voice matters to make this right!

1. What you guys think about this menu at the left?
2. What questions you expect answered in the FAQ?
3. What How-To do you want to see there?

If you are from the Amber team is okay to answer too but you should expect to be ignored unless you say something really representative to a wider audience.

Thanks!

--
You received this message because you are subscribed to the Google Groups "amber-lang" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.