Hi,
When Christopher was in Prague, a few of us had a brainstorming about
the need of having devel-documentation placed directly in a
Yast/libstorage/linuxrc repository. There are no doubts that it's one of
the most important parts of projects hosted at GitHub. All their howtos
mention "create README[.md]" as the very first step.
In fact, we'll have new hires in the team and in such situations, good
documentation is one of the most important parts. Good documentation
goes from very high level to lower and lower level.
We have already summarized that in Yast Team Challenges, but the summary
doesn't belong to this document as it's too detailed. That's why I'm
putting it here as a WIP item and deleting it from that document:
--- cut ---
The README should at least describe the steps needed for maintenance
(for a person without expert knowledge in the area) including:
* What is the project good for - what does it actually do (and how),
what it cannot do (unsupported scenarios), limitations
* Links to the documentation, high level and low level descriptions
(e.g. RFC, wikipedia articles, man pages, project documentation,
openSUSE wiki), terminology
* How to fetch the source code (if something outside Git is needed it
should be mentioned)
* What prerequisites are needed to build the sources (external
libraries, gems, scripts, …)
* How to build the sources (make/rake commands…)
* How to setup a testing environment (e.g. iSCSI target for iSCSI
client)
* How to run the code to test a change (esp. needed for non trivial
projects like linuxrc)
* How to run automated tests
* How to build a package for submission
* How to submit the package (if it needs some manual steps)
* Troubleshooting (how to solve typical problems)
The README should be reasonably short, if some section is too long it
should be moved to a separate document (or to GitHub wiki) and linked.
--- cut ---
The project consists of
- Taking a decision where to go
- How to get there
- Implementing this important documentation
Those two who, according to my knowledge, were working on this were
Ladislav and Christopher, but there were not the only ones and a pilot
project for READMEs has been done a few months ago by Martin. It's still
not finished, but moving forward.
Thanks
Lukas
--
Lukas Ocilka, Systems Management (Yast) Team Leader
SLE Department, SUSE Linux
--
To unsubscribe, e-mail: yast-devel+unsubscribe(a)opensuse.org
To contact the owner, e-mail: yast-devel+owner(a)opensuse.org
I want to fix yast2-slide-show for SLE11 SP3. Which git commands do I
have to use, please?
Thus far, I have checked out trunk only.
--
Karl Eichwalder SUSE LINUX Products GmbH
R&D / Documentation Maxfeldstraße 5
90409 Nürnberg, Germany
GF: Jeff Hawn, Jennifer Guild, Felix Imendörffer, HRB 16746 (AG Nürnberg)
--
To unsubscribe, e-mail: yast-devel+unsubscribe(a)opensuse.org
To contact the owner, e-mail: yast-devel+owner(a)opensuse.org
Hi all,
I have a good news for you, RSpec has been updated to version 3 in SLE12-SP1!
(Specifically to 3.3.x, I submitted the same version as is currently in Factory.)
That means we can now use RSpec3 syntax and the new features in the `master` Git
branch! Of course you have to be careful when backporting a SLE12 maintenance fix,
there is still RSpec2 in SLE12-GA...
See [1] for a nice overview of changes from RSpec2 to RSpec3.
Probably the most important new RSpec3 feature is the "verifying doubles" ability.
That feature checks that the mocked method is actually present on the specified
object. This avoids mocking non-existing methods which can make the test pass
but when the code is really executed it would fail with "NoMethod" error.
See [2] and [3] for more details, see [4] how to enable it as the feature is disabled
by default for backward compatibility.
Enjoy!
[1] http://rspec.info/blog/2014/05/notable-changes-in-rspec-3
[2] http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#verifying-doubles
[3] https://relishapp.com/rspec/rspec-mocks/docs/verifying-doubles
[4] https://relishapp.com/rspec/rspec-mocks/v/3-3/docs/verifying-doubles/partia…
--
Ladislav Slezák
Appliance department / YaST Developer
Lihovarská 1060/12
190 00 Prague 9 / Czech Republic
tel: +420 284 028 960
lslezak(a)suse.com
SUSE
--
To unsubscribe, e-mail: yast-devel+unsubscribe(a)opensuse.org
To contact the owner, e-mail: yast-devel+owner(a)opensuse.org
Hello,
Is it possible to manage (create/delete/modify) users stored in LDAP
backend using WebYAST?
Frankly speaking, I've failed to figure out how to do it, only local
users are available.
--
To unsubscribe, e-mail: yast-devel+unsubscribe(a)opensuse.org
To contact the owner, e-mail: yast-devel+owner(a)opensuse.org
