diff --git a/README.md b/README.md index a1bd5d6bb..b79779322 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,6 @@ Provided Functionality See [the generated yardoc documentation](http://www.rubydoc.info/github/yast/yast-yast2) at rubydoc.info. -Development -=========== - -This module is developed as part of YaST. See the generic -[development documentation](doc/README_Generic.md#yast-development-documentation) and -[development environment](doc/README_Generic.md#development-environment) description. - Getting the Sources =================== @@ -36,29 +29,11 @@ useful if you plan to contribute into the project and you do not have push permission to the repository. -Installing the Library -====================== - -See [the generic building and installing](doc/README_Generic_Autotools.md#building-and-installaing) -documentation. - - -Tests and Continuous Integration -================================ - -The tests are also run at a CI server, see -the [generic CI documentation](doc/README_Generic.md#continuous-integration) - - -Building and Submitting the Package -=================================== - -Before submitting any change please read our [contribution -guidelines](http://yastgithubio.readthedocs.org/en/latest/contributing/). +Development +=========== -See the generic YaST documentation how to -[build](doc/README_Generic_Autotools.md#building-the-package) - a package and [submit](doc/README_Generic.md#submitting-the-package) it to the Open Build Service (OBS). +This module is developed as part of YaST. See the +[development documentation](http://yastgithubio.readthedocs.org/en/latest/development/). Contact diff --git a/doc/README_Generic.md b/doc/README_Generic.md deleted file mode 100644 index e6c3ad774..000000000 --- a/doc/README_Generic.md +++ /dev/null @@ -1,61 +0,0 @@ -Generic YaST README File -======================== - -YaST Development Documentation ------------------------------- - -- [YaST development documentation](http://yast.github.io/documentation.html) -- [Contribution Guidelines](http://yast.github.io/guidelines.html) -- [YaST architecture](http://yastgithubio.readthedocs.org/en/latest/architecture) -- [Development environment](https://en.opensuse.org/openSUSE:YaST:_Preparing_the_Development_Environment) - - -Development Environment ------------------------ -Before doing anything useful with the code, you need to setup a development -environment. Fortunately, this is quite simple, see the [preparing development -environment](https://en.opensuse.org/openSUSE:YaST:_Preparing_the_Development_Environment) -documentation. - - -### Extra Development Tools ### - -For running the automated tests you might need to install some more packages: - - $ sudo zypper install yast2-testsuite rubygem-rspec rubygem-simplecov - - -Continuous Integration -====================== - -Travis CI ---------- - -YaST uses [Travis CI](https://travis-ci.org) for building and running tests for commits and pull requests. -You can find more details in the [Travis CI Integration] -(http://yastgithubio.readthedocs.org/en/latest/travis-integration/) documentation. - -Jenkins CI ----------- - -For builing on native (open)SUSE distibution we use -[Jenkins CI openSUSE server](https://ci.opensuse.org/view/Yast/). It also [submits](#automatic-submission) the -built package to OBS. - - -Submitting the Package -====================== - -Automatic Submission --------------------- - -The changes in `master` branch are automatically built and submitted to -[YaST:HEAD](https://build.opensuse.org/project/show/YaST:Head) OBS project -by [Jenkins CI](https://ci.opensuse.org/view/Yast/) after successful build. If the package version is changed then -a submit request to [openSUSE:Factory](https://build.opensuse.org/project/show/openSUSE:Factory) -is created automatically. - -Manual Submission ------------------ - -First build the package as described above. Then copy the content of `package/` directory to OBS project. diff --git a/doc/README_Generic_Autotools.md b/doc/README_Generic_Autotools.md deleted file mode 100644 index 804d60d03..000000000 --- a/doc/README_Generic_Autotools.md +++ /dev/null @@ -1,50 +0,0 @@ -Autotools Based YaST Packages -============================= - -This is a generic documenation for YaST packages which use autotools (autoconf/automake) -for building the package. - -Building and Installaing --------------------------- - -To build the module run these commands: - - $ make -f Makefile.cvs - $ make - -If you want to rebuild the module later simply run `make` again. - -To install it run: - - $ sudo make install - -Note: This will overwrite the existing module in the system, be carefull when installing -a shared component (library) as it migth break some other modules. - - -Starting the Module -------------------- - -Run the module as root - - # yast2 - -or start the YaST control panel from the desktop menu and then run the appropriate module. - - -Running the Automated Tests ---------------------------- - -To run the testsuite, use the `check` target: - - $ make check - - -Building the Package --------------------- - -To build a package for submitting into [Open Build Service](https://build.opensuse.org/) (OBS) you need to run - - $ make package-local - -in the top level directory. diff --git a/doc/README_Generic_Rake.md b/doc/README_Generic_Rake.md deleted file mode 100644 index 7ce3b4e02..000000000 --- a/doc/README_Generic_Rake.md +++ /dev/null @@ -1,51 +0,0 @@ -Rake Based YaST Packages -======================== - -This is a generic documenation for YaST packages which use `rake` for building the package. - -Building and Installaing ------------------------- - -So far the rake based modules do not need to be built, they are ready to be used just -after the Git clone. - -To install module run: - - $ sudo rake install - -Note: This will overwrite the existing module in the system, be carefull when installing -a shared component (library) as it migth break some other modules. - -Starting the Module -------------------- - -You can [start the installed module](README_Generic_Autotools.md#starting-the-module) -or you can run it directly from the Git checkout without need to install it first - -To run the module directly from the source code, use the `run` Rake task: - - $ rake run - - -Running the Automated Tests ---------------------------- - -To run the testsuite, use the `test:unit` Rake task: - - $ rake test:unit - -To run the tests with code coverage reporting run - - $ COVERAGE=1 rake test:unit - - -For a complete list of tasks, run `rake -T`. - - -Building the Package --------------------- - -To build a package for submitting into [Open Build Service](https://build.opensuse.org/) (OBS) you need to run - - $ rake tarball - diff --git a/doc/README_Template.md b/doc/README_Template.md index ab0486725..fbf494ca1 100644 --- a/doc/README_Template.md +++ b/doc/README_Template.md @@ -36,9 +36,8 @@ This YaST module configures .... Development =========== -This module is developed as part of YaST. See the generic -[development documentation](README_Generic.md#yast-development-documentation) and -[development environment](README_Generic.md#development-environment) description. +This module is developed as part of YaST. See the +[development documentation](http://yastgithubio.readthedocs.org/en/latest/development/). Getting the Sources @@ -59,17 +58,6 @@ Development Environment > otherwise remove this section.* -Installing and Starting the Module -=================================== - - -See [the generic building, installing](README_Generic_Rake.md#building-and-installaing) -and [running](README_Generic_Rake.md#starting-the-module) documentation. - -See [the generic building, installing](README_Generic_Autotools.md#building-and-installaing) -and [running](README_Generic_Autotools.md#starting-the-module) documentation. - - Testing Environment =================== @@ -80,26 +68,6 @@ Testing Environment > so it could be used by the client module.* -Tests and Continuous Integration -================================ - -The tests are also run at a CI server, see -the [generic CI documentation](README_Generic.md#continuous-integration) - - -Building and Submitting the Package -=================================== - -Before submitting any change please read our [contribution -guidelines](CONTRIBUTING.md). - - -See the generic YaST documentation how to -[build](README_Generic_Autotools.md#building-the-package) -[build](README_Generic_Rake.md#building-the-package) -a package and [submit](README_Generic.md#submitting-the-package) it to the Open Build Service (OBS). - - Troubleshooting ===============