EPICS Controls Argonne National Laboratory

Experimental Physics and
Industrial Control System

1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024  Index 1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024 
<== Date ==> <== Thread ==>

Subject: Re: Cross compiling for non-$EPICS_HOST_ARCH targets
From: Timo Korhonen via Tech-talk <tech-talk at aps.anl.gov>
To: Ralph Lange <ralph.lange at gmx.de>, EPICS Tech Talk <tech-talk at aps.anl.gov>
Date: Tue, 14 Apr 2020 15:37:34 +0000

Dear all,

 

To reply to Andrew’s request. Sorry that this is late, I missed the posts last week.

 

From: Tech-talk <tech-talk-bounces at aps.anl.gov> on behalf of Ralph Lange via Tech-talk <tech-talk at aps.anl.gov>
Reply-To: Ralph Lange <ralph.lange at gmx.de>
Date: Wednesday 8 April 2020 at 06:43
To: EPICS Tech Talk <tech-talk at aps.anl.gov>
Subject: Re: Cross compiling for non-$EPICS_HOST_ARCH targets

 

On Tue, 7 Apr 2020 at 22:27, Johnson, Andrew N. via Tech-talk <tech-talk at aps.anl.gov> wrote:

Hey Ralph & Timo, in case you aren’t already working on it, we probably need a How-to on contributing to the How-to’s that we can point potential contributors to...

 

Yes, definitely.

It should be in the place that no one finds because no links are pointing there.

 

~Ralph

 

Well... in true EPICS tradition, there is not only one but two ways how to contribute a how-to article!

 

To start, here is one link: https://epics-controls.org/resources-and-support/documents/howto-documents/

 

For this one, the “how to contribute” would be like this:

-create yourself an account on the epics-controls.org website and let us (Ralph, Andrew or myself) know that you want to contribute a how-to article. We will give you the correct “role” on the site. Just having an account does not let you do that much. But with the correct role you can also access instructions on how to write and publish articles (those instructions contain more details than this short email.)

-learn a bit of WordPress. It is not that difficult, believe me. The (relatively) new editor is WYSIWYG and if you can write an email you can for sure use the editor as well.

-Create a new page, submit it to review workflow and as soon as one of the reviewers accepts the content, it will appear on the website.

 

But there is also another way and as far as I understand, this is the one that we agreed to go for in the long run:

 

First the link:

https://docs.epics-controls.org/projects/how-tos/en/latest/

 

(it is also linked from here : https://epics-controls.org/resources-and-support/documents/ but probably not prominently enough.)

 

And the corresponding Github repo:

 

https://github.com/epics-docs/how-tos

 

This method uses readthedocs.org as a build and publishing provider. The process is  roughly the following:

 

  • learn basics of reStructuredText if you are not yet familiar with that format. Also some git skills are useful.
  • fork the above repo and add a new article. Consult Ralph or myself to figure out where to put the new file if needed. All other related questions are also welcome.
  • When you are done with editing, create a pull request. One of the project members will merge, and the document appears on the docs.epics-controls.org website.
  • Or, you can ask to  become a member in the how-tos (or epics-docs) project(s) so that you can commit directly to that project. Help is always welcome.
  • There are some additional fine points like adding the new document to the index file, etc., but if you contribute the text I offer to take care of the rest (unless I start getting hundreds of contributions…I consider that rather unlikely, though.)

 

The second way was created because we thought that this would be easier to get familiar with for people who work mostly in software, and the editing in the epics-controls website was a bit complicated earlier. Now the new editor in WordPress is (IMHO) so easy that maybe it is not an issue anymore.

The other point was also that the second method can also host documentation produced by Doxygen and that would enable us to collect all the related docs under the same site.

 

I hope this gives some pointers. Comments, suggestions and, above all, contributions are welcome!

 

Best regards,

 

Timo

 


References:
Cross compiling for non-$EPICS_HOST_ARCH targets R Nussbaumer via Tech-talk
Re: Cross compiling for non-$EPICS_HOST_ARCH targets Johnson, Andrew N. via Tech-talk
Re: Cross compiling for non-$EPICS_HOST_ARCH targets Ralph Lange via Tech-talk

Navigate by Date:
Prev: RE: StreamDevice, prevent records from getting "stuck" Sobhani, Bayan via Tech-talk
Next: Re: StreamDevice, prevent records from getting "stuck" Mark Davis via Tech-talk
Index: 1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024 
Navigate by Thread:
Prev: Re: Cross compiling for non-$EPICS_HOST_ARCH targets Ralph Lange via Tech-talk
Next: ci-scripts 2.2.1 available Ralph Lange via Tech-talk
Index: 1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  2016  2017  2018  2019  <20202021  2022  2023  2024 
ANJ, 14 Apr 2020 Valid HTML 4.01! · Home · News · About · Base · Modules · Extensions · Distributions · Download ·
· Search · EPICS V4 · IRMIS · Talk · Bugs · Documents · Links · Licensing ·