review different 'getting started' guides in the wiki and unify/update them
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.
#2 Updated by laforge over 1 year ago
for example, we have the following partial redundant info:
- only keep lcr related part
- only keep asterisk related part, probably builds on LCR part above
- mention that this is obsolete and osmo-sip-connector should be used (BOLD NOTICE)
- always refer to nightly debian packages as better alternative for non-developers
- manuals from manuals.git
- one page about installing the software (from nightly debian feed, alternatively compilation from source)
- configuration, possibly containing references to the manual whenever appropriate
#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:
- How to run osmo-nitb with GPRS
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 about 1 year ago
- Assignee changed from dexter to 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.
#9 Updated by neels about 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.
#11 Updated by neels about 1 year ago
- Assignee changed from neels to wirelesss
- 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.
#15 Updated by wirelesss about 1 year ago
Following pages has been completed for review :
#16 Updated by neels about 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
- 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.
- 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: goodOpenBSC with Asterisk:
- again fix the link formats
- I took the liberty to shorten a sentence.
#19 Updated by wirelesss about 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
Redundant information related to building openbsc has been removed.
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.