Project

General

Profile

Support #1719

review different 'getting started' guides in the wiki and unify/update them

Added by laforge almost 2 years ago. Updated 23 days ago.

Status:
Stalled
Priority:
High
Assignee:
Target version:
-
Start date:
05/17/2016
Due date:
% Done:

50%

Spec Reference:

Description

There are plenty of different guides on how to compile + configure + run an OpenBSC based network. Some related to OsmoTRX based BTSs, some to nanoBTS, some ot E1 based BTSs.

Let's clean this up and divided it into
  • sections that are common among all configurations
  • sections that are related to a specific BTS hardware (or hardware class)

Also clearly indicate that building the software from source is only an optional step and refer to the OBS dpkg nightly builds as preferred method for regular users.


Related issues

Related to Cellular Network Infrastructure - Feature #2618: write Osmocom Network In The Box wiki page Closed 11/07/2017

History

#1 Updated by laforge over 1 year ago

  • Priority changed from Normal to High

#2 Updated by laforge over 1 year ago

for example, we have the following partial redundant info:

Let's split in:
  • one page about installing the software (from nightly debian feed, alternatively compilation from source)
  • configuration, possibly containing references to the manual whenever appropriate

#3 Updated by laforge over 1 year ago

  • Assignee deleted (dlsitzer)

#4 Updated by laforge over 1 year ago

  • Assignee set to dexter

#5 Updated by dexter over 1 year ago

Before starting wildly editing the Wiki I wanted to share my thoughts:

I look at http://osmocom.org/projects/cellular-infrastructure/wiki I find a short reference page for each product, I also find a link to the manuals there. Why not having another two sections "Installation" for the normal users and "Build instructions" for developers? To me this would be much more logic. The disadvantage would be that the build instructions spread over multiple page. If I need GPRS for example, I have to get the build/install instructions from three different pages. However, this can be compensated by having howtos in the getting started sections that refer to the product pages:

e.g.:
Getting started
- UnderstandingOpenBSC....
- NightlyBuilds....
- How to run osmo-nitb with GPRS

Wiki page:
How to run osmo-nitb with GPRS

- Please install: OsmoNITB, OsmoSGSN, OpenGGSN
- Configure this and that ...
- Run ...

We also should have a howto for the most minimal setup so that someone who is new to the project can get some immediate success. This also gives the opportunity to refer to it. It would be like a tutorial, where we start with basics and end up with a fully functional core network with Voip-Dialout and GPRS.

Then there is this second overview page, I believe this is the original old one from the Trac: http://osmocom.org/projects/openbsc/wiki I think this is very confusing. Its not clear which directory is the right one. I think we should merge the two and have only one directory. The directory should also be complete in the sense that it also lists the sub-pages, so we can keep the overview and everything would be accessible with one click.

#6 Updated by laforge over 1 year ago

  • Assignee changed from dexter to neels

Hi neels,

please take ownership of this ticket and involve wirelesss in the actaul excecution. WE need one set of conscise (and possibly modular?) guides (common parts, bts specific parts). As in my original issue description, building code from source should rather be the exception and described at one location in the wiki, for those people that really want to get to that point.

All reference information should rather be referred to the manuals. The manuals must also be linked at frequent and obvious locations, so people actually find and use them.

#7 Updated by neels over 1 year ago

ack

#9 Updated by neels over 1 year ago

Looking at the Cellular Infrastructure wiki and the various pages, I agree with dexter
that a comprehensive rearranging of the wiki structure would be a good idea.

While I can probably incorporate some help from wirelesss here and there, I guess
the bulk of this work will remain on my desk, since deep understanding of the
components + bigger picture would benefit the end result.

Since I'm also starting on the VLR/HLR task, the question of prioritization remains.
I could dedicate a day per month to wiki improvements, for example.

#10 Updated by neels over 1 year ago

  • % Done changed from 0 to 30

I've started by adding section Build from Source to generally describe the build process.
Still todo: remove duplications of this information in the mentioned older wiki pages,
retaining only the specific details for those contexts.

#11 Updated by neels over 1 year ago

  • Assignee changed from neels to wirelesss

Todo:

  • For each of above links, remove any information that is already in Build from source.
  • Move information that is also useful elsewhere to Build from source.
    Keep only that information that is only useful for that wiki page.
  • Only list which projects need to be built, and link to Build from source.
  • For any special settings/issues with a given project, expand the "Details and troubleshooting"
    section in Build from source.
  • Possibly add more examples to the bottom of Build from source, if that makes sense.

#12 Updated by wirelesss over 1 year ago

  • Status changed from New to In Progress
  • % Done changed from 30 to 40

Cleaning of the redundant information from links above is started.

#13 Updated by wirelesss over 1 year ago

  • % Done changed from 40 to 50

#14 Updated by neels over 1 year ago

wirelesss, please update this ticket. Name those pages that are complete.

#16 Updated by neels over 1 year ago

Take a look at the redmine documentation about the format of links
(click the small blue question mark when editing a page)

links within redmine, same Project: [[SDR OsmoTRX network from scratch]]
links within redmine, across Projects: [[OsmoTRX:]]
Link to a subsection: [[Build from source#Example-completely-build-openbsc|Example: completely build openbsc]]
external links: http://jenkins.osmocom.org

links within redmine, same Project: SDR OsmoTRX network from scratch
links within redmine, across Projects: OsmoTRX
Link to a subsection: Example: completely build openbsc
external links: http://jenkins.osmocom.org

SDR OsmoTRX network from scratch:
  • Fix at least the links you added/edited.
  • if you like, also fix the other links that are broken all over that wiki page, shown in red.
    They are broken because the migration from trac to redmine composed inaccurate links.
In OpenBSC LCR Ubuntu1204:
  • fix link formats
  • (there was no need to edit the instructions for misdn.git software)
  • you write only "download following sources as described in Build_from_source",
    it should say "install", or even "download, build and install".
  • Where you link to the "build openbsc" example directly: you are instructing the reader
    to build openbsc again? Above it already linked to Build from source?

OpenBSC GPRS: good

OpenBSC with Asterisk:
  • again fix the link formats
  • I took the liberty to shorten a sentence.

#17 Updated by neels over 1 year ago

In OpenBSC with Asterisk, I also fixed the order: openbsc depends on libosmocore and libosmo-abis, so it should be on the bottom.
Make sure the order reflects dependency in the other wiki pages as well.

#18 Updated by neels over 1 year ago

I also edited the Debian Packages section to be more general

#19 Updated by wirelesss over 1 year ago

Broken links have been fixed.

Unable to use short format of link: https://osmocom.org/projects/osmonitb/wiki/OsmoNITB_LCR in OpenBSC with Asterisk

and https://osmocom.org/projects/openbsc/wiki/Multi-BTS_with_handover in SDR OsmoTRX network from scratch

Redundant information related to building openbsc has been removed.

#20 Updated by wirelesss over 1 year ago

Short format of wiki links found and used in pages:

#21 Updated by neels over 1 year ago

SDR OsmoTRX network from scratch says "Refer to page OsmoTRX for build instructions."
but osmo-trx has no build instructions! Rather, also add 'osmo-trx' to the list of projects
for Build from source.

#22 Updated by wirelesss over 1 year ago

osmo-trx project is added to the list of project for Build from source in SDR OsmoTRX network from scratch.

Pages listed below has been completed for review :

Ettus USRP B2xx family

OsmoNITB LCR

Building OpenBSC

#23 Updated by laforge about 1 year ago

  • Assignee changed from wirelesss to neels

#24 Updated by neels about 1 year ago

  • Status changed from In Progress to Stalled

will need to have a look at what still needs to be done.

#25 Updated by neels 11 months ago

my attention is firmly on other topics; but it might be good to wrap this up at some point not too distant in the future...

#26 Updated by neels 6 months ago

With the openbsc.git split up and addition of M3UA, it increasingly feels like we should completely overhaul our wiki structure,
to clarify the different styles of Osmocom network that are now available.

dexter mentioned the idea of starting off with a brand new main page, and building "a new wiki" from there.
We could do this in a separate location first and later move the new page into place.

We should also link to it from the redmine project descriptions, so that users are led into the wiki section in more obvious terms.

#27 Updated by neels 5 months ago

  • Related to Feature #2618: write Osmocom Network In The Box wiki page added

#28 Updated by laforge 23 days ago

  • Assignee changed from neels to daniel

Also available in: Atom PDF