Skip to content

Commit

Permalink
add overview to frontend
Browse files Browse the repository at this point in the history
  • Loading branch information
jreidinger committed Jun 19, 2019
1 parent 6c6bf8e commit fb2b4b2
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 12 deletions.
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
YaST Network Module
======================
## YaST Network Module

[![Travis Build](https://travis-ci.org/yast/yast-network.svg?branch=master)](https://travis-ci.org/yast/yast-network)
[![Jenkins Build](http://img.shields.io/jenkins/s/https/ci.opensuse.org/yast-network-master.svg)](https://ci.opensuse.org/view/Yast/job/yast-network-master/)
Expand All @@ -9,8 +8,7 @@ YaST Network Module
The YaST2 Network module manages network configuration including device configuration,
DNS, Routing and more

Features
--------
## Features

* device configuration via netconfig
* network service selection (netconfig, NetworkManager, wicked)
Expand All @@ -20,15 +18,13 @@ Features

Some features are SuSE Linux specific.

Installation
------------
## Installation

To install the latest stable version on openSUSE or SLE, use zypper:

$ sudo zypper install yast2-network

Running
-------
## Running

To run the module, use the following command as root:

Expand All @@ -38,16 +34,26 @@ This will start complex dialog with most of features available.
For more options see section on [running YaST](https://en.opensuse.org/SDB:Starting_YaST)
in the YaST documentation.

Documentation
-------------
## Documentation

User YaST documentation is available in [general YaST documentation](https://en.opensuse.org/Portal:YaST).

Developer documentation specific for this module is in the [doc](doc)
directory.

Development
-----------
### Overview

#### Frontend
![overview picture](doc/overview.svg)

Now frontend mostly describes Add/Edit dialog for interfaces which is the most complex. For links to parts see:

* [Interface Config Builder](https://www.rubydoc.info/github/yast/yast-network/master/Y2Network/InterfaceConfigBuilder)
* [Add Dialog](https://www.rubydoc.info/github/yast/yast-network/master/Y2Network/Dialogs/AddInterface)
* [Edit Dialog](https://www.rubydoc.info/github/yast/yast-network/master/Y2Network/Dialogs/EditInterface)
* Tabs and Widgets live in Y2Network::Widgets

## Development

This module is developed as part of YaST. See
[YaST development documentation](
Expand Down
1 change: 1 addition & 0 deletions doc/frontend.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fb2b4b2

Please sign in to comment.