You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@nuttx.apache.org by Gregory Nutt <sp...@gmail.com> on 2019/12/18 17:01:44 UTC
Getting Started (Was Re: [DISCUSS - NuttX Workflow])
On 12/18/2019 10:47 AM, Nathan Hartman wrote:
> On Wed, Dec 18, 2019 at 11:04 AM David Sidrane <da...@apache.org> wrote:
>> What about the people who are just learning Nuttx? Simple is relative.
> We never had a Getting Started guide. We need one. And because it's so
> hard for someone "in the know" not to assume knowledge, we may need
> the help of some total n00bs to get this guide written -- to see where
> they get stuck and waste time looking for answers, and write those
> things in the guide. But that's a subject for another thread.
There is this: http://www.nuttx.org/doku.php?id=wiki:getting-started
where the "external tutorials" is quite extensive:
http://www.nuttx.org/doku.php?id=wiki:getting-started:external-tutorials
Re: nuttx.events
Posted by Flavio Junqueira <fp...@apache.org>.
Hi Greg,
It is ok to discuss separately the organization of events, they don't need to happen on the project mailing lists. If the event is open to the community with an open call for abstracts, then you might want to announce it on the user/dev lists. Some communities do not like it, though. If there is a company backing such an event, people could complain that it is not a neutral event and as such should not be advertised on the Apache lists.
As a sample point, I have never organized events using the Apache lists or any other channels, but we have announced project meetups to let people sign up to attend and present.
-Flavio
> On 18 Dec 2019, at 20:06, Gregory Nutt <sp...@gmail.com> wrote:
>
> This is a question for Justin or any other mentor.
>
> There are a couple of associated web sites that are dedicated for NuttX event planning: nuttx2019.org and https://nuttx.events/. nuttx2019.org now just re-directs to nuttx.events. They event planners used to use a private channel in the NuttX Slack for communication. However, the NuttX project can no longer host private conversations in the NuttX Slack;
>
> nuttx.events is managed by Dave Marples.. It is fairly open but they need to have some private discussions related to events, event planning, sponsor relationships, etc. For example, planning is (or at least was) underway for the NuttX2020 event in Tokyo in May. I am not sure what they are doing now.. I hope I didn't undermine them too badly.
>
> So the question is, after having booted event planning out into the cold, is there some way to bring it back into the fold. There must be other projects that host events and must have similar planning needs. Do you know what the standard practice is for such things? I imagine that an independent group like nuttx.events is necessary, but is there any way to coordinate. Slack private channels worked very well for this. I don't know what the replacement could be and would be open to suggestions.
>
> Greg
>
>
Re: nuttx.events
Posted by "张铎 (Duo Zhang)" <pa...@gmail.com>.
For HBaseCon, usually the discussion will first be made in the private
mailing list, to get enough PMC members support, and then you can post it
in the public mailing list to get the PC members for reviewing and
accepting the submissions, and also a PMC member must send an email to the
trademarks mailing list to acquire the permission to use the trademarks for
'Apache NuttX', on the materials for this event. The website is fine,
usually it will be hosted by the company which hosts the event.
Justin Mclean <ju...@classsoftware.com> 于2019年12月19日周四 上午5:35写道：
> Hi,
>
> It’s best if the PMC are involved in some way, ideally they would have a
> hand in selecting the speakers, and the event would have the ASF as a
> community sponsor. For more details see [1]. Given this is an event already
> in the planning process and you're an incubating project there’s going to
> be some leeway but I don’t see anything there that would be too hard to
> take into consideration (says someone not on the planning committee :-) )
> Out of interest how large is the event expected to be? You also might also
> want to considering having the event added here [2.]
>
> Thanks,
> Justin
>
> 1. https://www.apache.org/foundation/marks/events.html
> 2. http://community.apache.org/calendars/
Re: nuttx.events
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
It’s best if the PMC are involved in some way, ideally they would have a hand in selecting the speakers, and the event would have the ASF as a community sponsor. For more details see [1]. Given this is an event already in the planning process and you're an incubating project there’s going to be some leeway but I don’t see anything there that would be too hard to take into consideration (says someone not on the planning committee :-) ) Out of interest how large is the event expected to be? You also might also want to considering having the event added here [2.]
Thanks,
Justin
1. https://www.apache.org/foundation/marks/events.html
2. http://community.apache.org/calendars/
nuttx.events
Posted by Gregory Nutt <sp...@gmail.com>.
This is a question for Justin or any other mentor.
There are a couple of associated web sites that are dedicated for NuttX
event planning: nuttx2019.org and https://nuttx.events/. nuttx2019.org
now just re-directs to nuttx.events. They event planners used to use a
private channel in the NuttX Slack for communication. However, the
NuttX project can no longer host private conversations in the NuttX Slack;
nuttx.events is managed by Dave Marples.. It is fairly open but they
need to have some private discussions related to events, event planning,
sponsor relationships, etc. For example, planning is (or at least was)
underway for the NuttX2020 event in Tokyo in May. I am not sure what
they are doing now.. I hope I didn't undermine them too badly.
So the question is, after having booted event planning out into the
cold, is there some way to bring it back into the fold. There must be
other projects that host events and must have similar planning needs.
Do you know what the standard practice is for such things? I imagine
that an independent group like nuttx.events is necessary, but is there
any way to coordinate. Slack private channels worked very well for
this. I don't know what the replacement could be and would be open to
suggestions.
Greg
RE: Getting Started (Was Re: [DISCUSS - NuttX Workflow])
Posted by di...@gmail.com.
My current state is that the outline is formed and that the filling per "chapter" is on its way and that the purpose of the book is set. Its public is also for people who come across Nuttx for the first time and do not have seen movies or other tutorials from Nuttx and did not have the privilege to meet all of you as I have. Say like people who start with a platform like Arduino. So there is a global introduction to all the aspects which I already mentioned: Architecture, Concepts, etc...
Also, the outline base is on real use cases, and the book will take you through hands-on situations. So you do not only read about the Architecture of Nuttx, but also you are taken on a journey by really make things happen. It also concerns setting up a development process (IDE, debugging, etc.). Arduino has its IDE. I am writing all the examples in Visual Studio Code and here I have to get the debugging solid. In Eclipse, it looks more advanced. And using a Segger is also an option, but OpenOCD is free and open for STM32. So a choice is made here. It has to be around for many years and not have a Vendor Lock-in.
But before I can write out the use cases, I have to do them myself so I know all the written use cases and code tested thoroughly. There is nothing more killing then referring something in a book and it's not working. Also, I had to choose a reference platform for the book on which all the use cases are implemented. Even I do know what an RTOS is and its nota bout hardware... one has to choose a reference platform for the book. And for this, I have chosen the STM32 hardware. I do not have any commitment to a hardware supplier, but one has to make a choice. And STM32 has some good criteria for real beginners... especially in costs vs. functionality.
So I am doing a lot of work daily (next to a job I have to do) to get all the things done. But writing a book has to be fun and a learning experience. I also am in contact with Alan concerning the use cases and testing. And a publisher who has understanding fort he previous matters. Better do things right than in chaos.
If some-one wants an update, I am always willing to share this. I am also very anxious to see the progress on Nuttx and I do not see a roadmap here. My roadmap is clear... but I now have all the links to Nuttx on the bitbucket repo and the BSD platform. So I cannot bring out anything until I know ho wand what and when the Apache release is ready in a state like the previous platform was, where I could commit my patches, which now have a link with this writing process.
Good luck tot he PMC and people who are doing this great job, and I am reading all the emails about status and progress.
Ben
-----Oorspronkelijk bericht-----
Van: Gregory Nutt <sp...@gmail.com>
Verzonden: woensdag 18 december 2019 20:31
Aan: dev@nuttx.apache.org
Onderwerp: Re: Getting Started (Was Re: [DISCUSS - NuttX Workflow])
Ben vd Veen has been working on a NuttX getting started book for a few months. I don't know the current state. There was a channel on the old NuttX Slack devoted to the book, but it has not been updated in a very long time. Perhaps Ben could fill us in on the current state, progress, and where it is going.
BTW: I have archived the channels and deactivated most of the members. It is no longer viable for anything and I may as well shut down that Slack now. There is nothing to see there now.
On 12/18/2019 1:34 PM, Abdelatif Guettouche wrote:
>> I'd prefer that the Getting Started guide should be reachable by one
>> click from the front page of the NuttX website (which doesn't exist
>> yet), so that a TOTAL newbie who hasn't even gotten the code yet can
>> read and get a feel for what's involved.
> Agree.
> I wanted to point out that much of the content needed to make such a
> document is already in place.
>
>> Yes, much of the information is in the README file. Perhaps we can
>> modify text files like that to be in Markdown format, which unlike
>> HTML, leaves the file looking like a normal ASCII file, but allows
>> the file to be converted to other formats, including HTML, using
>> automated tools. Then we could convert that information and display
>> it directly on the website.
> That would helpful.
> Some of the readme files are already (almost) in Markdown format.
>
>
> On Wed, Dec 18, 2019 at 5:46 PM Nathan Hartman <ha...@gmail.com> wrote:
>> On Wed, Dec 18, 2019 at 12:01 PM Gregory Nutt <sp...@gmail.com> wrote:
>>> There is this: http://www.nuttx.org/doku.php?id=wiki:getting-started
>>> where the "external tutorials" is quite extensive:
>>> http://www.nuttx.org/doku.php?id=wiki:getting-started:external-tutor
>>> ials
>> That's great but I think we need our own basic Getting Started guide
>> that gets a total newbie off the ground quickly; it can, of course,
>> have an "Additional Resources" section with links to all of these
>> other resources.
>>
>> On Wed, Dec 18, 2019 at 12:31 PM Abdelatif Guettouche
>> <ab...@gmail.com> wrote:
>>> Boards readme files contain all the information needed to get
>>> started with a particular board.
>> Again, that's great, but it presumes that you have the code, know
>> about the board READMEs, know where they are...
>>
>> I'd prefer that the Getting Started guide should be reachable by one
>> click from the front page of the NuttX website (which doesn't exist
>> yet), so that a TOTAL newbie who hasn't even gotten the code yet can
>> read and get a feel for what's involved.
>>
>> Yes, much of the information is in the README file. Perhaps we can
>> modify text files like that to be in Markdown format, which unlike
>> HTML, leaves the file looking like a normal ASCII file, but allows
>> the file to be converted to other formats, including HTML, using
>> automated tools. Then we could convert that information and display
>> it directly on the website.
>>
>> Nathan
Re: Getting Started (Was Re: [DISCUSS - NuttX Workflow])
Posted by Gregory Nutt <sp...@gmail.com>.
Ben vd Veen has been working on a NuttX getting started book for a few
months. I don't know the current state. There was a channel on the old
NuttX Slack devoted to the book, but it has not been updated in a very
long time. Perhaps Ben could fill us in on the current state, progress,
and where it is going.
BTW: I have archived the channels and deactivated most of the members.
It is no longer viable for anything and I may as well shut down that
Slack now. There is nothing to see there now.
On 12/18/2019 1:34 PM, Abdelatif Guettouche wrote:
>> I'd prefer that the Getting Started guide should be reachable by one
>> click from the front page of the NuttX website (which doesn't exist
>> yet), so that a TOTAL newbie who hasn't even gotten the code yet can
>> read and get a feel for what's involved.
> Agree.
> I wanted to point out that much of the content needed to make such a
> document is already in place.
>
>> Yes, much of the information is in the README file. Perhaps we can
>> modify text files like that to be in Markdown format, which unlike
>> HTML, leaves the file looking like a normal ASCII file, but allows the
>> file to be converted to other formats, including HTML, using automated
>> tools. Then we could convert that information and display it directly
>> on the website.
> That would helpful.
> Some of the readme files are already (almost) in Markdown format.
>
>
> On Wed, Dec 18, 2019 at 5:46 PM Nathan Hartman <ha...@gmail.com> wrote:
>> On Wed, Dec 18, 2019 at 12:01 PM Gregory Nutt <sp...@gmail.com> wrote:
>>> There is this: http://www.nuttx.org/doku.php?id=wiki:getting-started
>>> where the "external tutorials" is quite extensive:
>>> http://www.nuttx.org/doku.php?id=wiki:getting-started:external-tutorials
>> That's great but I think we need our own basic Getting Started guide
>> that gets a total newbie off the ground quickly; it can, of course,
>> have an "Additional Resources" section with links to all of these
>> other resources.
>>
>> On Wed, Dec 18, 2019 at 12:31 PM Abdelatif Guettouche
>> <ab...@gmail.com> wrote:
>>> Boards readme files contain all the information needed to get started
>>> with a particular board.
>> Again, that's great, but it presumes that you have the code, know
>> about the board READMEs, know where they are...
>>
>> I'd prefer that the Getting Started guide should be reachable by one
>> click from the front page of the NuttX website (which doesn't exist
>> yet), so that a TOTAL newbie who hasn't even gotten the code yet can
>> read and get a feel for what's involved.
>>
>> Yes, much of the information is in the README file. Perhaps we can
>> modify text files like that to be in Markdown format, which unlike
>> HTML, leaves the file looking like a normal ASCII file, but allows the
>> file to be converted to other formats, including HTML, using automated
>> tools. Then we could convert that information and display it directly
>> on the website.
>>
>> Nathan
Re: Getting Started (Was Re: [DISCUSS - NuttX Workflow])
Posted by Abdelatif Guettouche <ab...@gmail.com>.
> I'd prefer that the Getting Started guide should be reachable by one
> click from the front page of the NuttX website (which doesn't exist
> yet), so that a TOTAL newbie who hasn't even gotten the code yet can
> read and get a feel for what's involved.
Agree.
I wanted to point out that much of the content needed to make such a
document is already in place.
> Yes, much of the information is in the README file. Perhaps we can
> modify text files like that to be in Markdown format, which unlike
> HTML, leaves the file looking like a normal ASCII file, but allows the
> file to be converted to other formats, including HTML, using automated
> tools. Then we could convert that information and display it directly
> on the website.
That would helpful.
Some of the readme files are already (almost) in Markdown format.
On Wed, Dec 18, 2019 at 5:46 PM Nathan Hartman <ha...@gmail.com> wrote:
>
> On Wed, Dec 18, 2019 at 12:01 PM Gregory Nutt <sp...@gmail.com> wrote:
> > There is this: http://www.nuttx.org/doku.php?id=wiki:getting-started
> > where the "external tutorials" is quite extensive:
> > http://www.nuttx.org/doku.php?id=wiki:getting-started:external-tutorials
>
> That's great but I think we need our own basic Getting Started guide
> that gets a total newbie off the ground quickly; it can, of course,
> have an "Additional Resources" section with links to all of these
> other resources.
>
> On Wed, Dec 18, 2019 at 12:31 PM Abdelatif Guettouche
> <ab...@gmail.com> wrote:
> > Boards readme files contain all the information needed to get started
> > with a particular board.
>
> Again, that's great, but it presumes that you have the code, know
> about the board READMEs, know where they are...
>
> I'd prefer that the Getting Started guide should be reachable by one
> click from the front page of the NuttX website (which doesn't exist
> yet), so that a TOTAL newbie who hasn't even gotten the code yet can
> read and get a feel for what's involved.
>
> Yes, much of the information is in the README file. Perhaps we can
> modify text files like that to be in Markdown format, which unlike
> HTML, leaves the file looking like a normal ASCII file, but allows the
> file to be converted to other formats, including HTML, using automated
> tools. Then we could convert that information and display it directly
> on the website.
>
> Nathan
Re: Getting Started (Was Re: [DISCUSS - NuttX Workflow])
Posted by Nathan Hartman <ha...@gmail.com>.
On Wed, Dec 18, 2019 at 12:01 PM Gregory Nutt <sp...@gmail.com> wrote:
> There is this: http://www.nuttx.org/doku.php?id=wiki:getting-started
> where the "external tutorials" is quite extensive:
> http://www.nuttx.org/doku.php?id=wiki:getting-started:external-tutorials
That's great but I think we need our own basic Getting Started guide
that gets a total newbie off the ground quickly; it can, of course,
have an "Additional Resources" section with links to all of these
other resources.
On Wed, Dec 18, 2019 at 12:31 PM Abdelatif Guettouche
<ab...@gmail.com> wrote:
> Boards readme files contain all the information needed to get started
> with a particular board.
Again, that's great, but it presumes that you have the code, know
about the board READMEs, know where they are...
I'd prefer that the Getting Started guide should be reachable by one
click from the front page of the NuttX website (which doesn't exist
yet), so that a TOTAL newbie who hasn't even gotten the code yet can
read and get a feel for what's involved.
Yes, much of the information is in the README file. Perhaps we can
modify text files like that to be in Markdown format, which unlike
HTML, leaves the file looking like a normal ASCII file, but allows the
file to be converted to other formats, including HTML, using automated
tools. Then we could convert that information and display it directly
on the website.
Nathan
Re: Getting Started (Was Re: [DISCUSS - NuttX Workflow])
Posted by Gregory Nutt <sp...@gmail.com>.
> Boards readme files contain all the information needed to get started
> with a particular board.
Many do. They all should. They vary in quality. Some board README
files have no useful information at all; some have old information.
Some consist of only a few lines, some are thousands of lines. Some
boards don't any any README files.
The board README files are very helpful. Even for me. If I have not
worked with a board for a couple of years, the README file brings me
back up to speed very quickly.
Unfortunately the content is not consistent, controlled, or properly
maintained.
Greg
Re: Getting Started (Was Re: [DISCUSS - NuttX Workflow])
Posted by Abdelatif Guettouche <ab...@gmail.com>.
Boards readme files contain all the information needed to get started
with a particular board.
On Wed, Dec 18, 2019 at 5:01 PM Gregory Nutt <sp...@gmail.com> wrote:
>
> On 12/18/2019 10:47 AM, Nathan Hartman wrote:
> > On Wed, Dec 18, 2019 at 11:04 AM David Sidrane <da...@apache.org> wrote:
> >> What about the people who are just learning Nuttx? Simple is relative.
> > We never had a Getting Started guide. We need one. And because it's so
> > hard for someone "in the know" not to assume knowledge, we may need
> > the help of some total n00bs to get this guide written -- to see where
> > they get stuck and waste time looking for answers, and write those
> > things in the guide. But that's a subject for another thread.
>
> There is this: http://www.nuttx.org/doku.php?id=wiki:getting-started
> where the "external tutorials" is quite extensive:
> http://www.nuttx.org/doku.php?id=wiki:getting-started:external-tutorials
>