yigid/openairinterface5g
1
0
Fork 0
mirror of https://gitlab.eurecom.fr/oai/openairinterface5g.git synced 2026-07-13 04:30:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
Page: WikiUsage
Pages
5g nr development and setup ALUProject AskQuestions AutoBuild CBMIMO1Integ CardList Cbmimo1Flash Chorist3Nodes ChoristMplsIPv6072008 Code Exection Timing Measurements Configure_simplestreams_for_a_private_cloud CoreBasebandAndRF CoreNetworking DebugTools DeployOpenStackHeat DisablingInterrupts EmosCompile EmosDocumentation EmosEvaluation EmosManual EmosMatlab EmosMeasurements EmosPapers EmosTasklist EthEmul3NodesIPv4 EurecomBilk EurecomEquipmentStatus EurecomMimoOpenairSounder EurecomTuB ExpressMIMO ExpressMIMO2 ExpressMIMOCalibration ExpressmimoFlashProgram FAQ FirstMeasurement Generating_configuration_for_Juju GetSources HW and OS HowToCalibrateeNBandUE HowToConnectCOTSUEwithOAIeNB HowToConnectCOTSUEwithOAIeNBNew HowToConnectOAIENBWithOAIUEWithS1Interface HowToConnectOAIENBWithOAIUEWithoutS1Interface HowtoconnectCOTSUEtoOAIeNBviaRRHGW HowtorunoaisimwithvirtualMMEonsamemachine InstallLibraries IttiAnalyzer LTE M Setup LTESeminarSeries M CORD_OAI_Discussion_20161025 Machines and OS MailingList MeshFrameStructure MeshSynchronzation MeshTasklist MissionChecklist NB IoT Overview NetworksUEs NodeB OAIOnArmOdroid OAI_Dev_Call_20150616 OAIinDocker OAIonJuJu OldSVNRelease OlderReleases OpenAir1CoreDev OpenAir2CoreDev OpenAir2Examples OpenAirCellular OpenAirCriticalIssues OpenAirDebug OpenAirDevMeetings OpenAirEmuUbuntu1004Kernel26294x86Setups OpenAirEmuUbuntu1004KernelGenericSetups OpenAirEmulDev OpenAirEmulation OpenAirExpressMimo2 OpenAirFeatures OpenAirInterface OpenAirKernel2632genericx86Setups OpenAirKernel357Ubuntu1204x86Setups OpenAirKernel357genericx86Setups OpenAirKernelMainSetup OpenAirKernelSetups OpenAirLTEEmulation OpenAirLTEGuidelines OpenAirLTEPhySimul OpenAirLXRT OpenAirLogo OpenAirMatlab OpenAirOctave OpenAirPhySimul OpenAirProjects OpenAirRTCompilation OpenAirRTDebug OpenAirRadioEmulation OpenAirRadioEmulationDescription OpenAirRadioEmulationUserManual OpenAirReleases OpenAirSoftwareSupport OpenAirSystemRequirements OpenAirTemplateProject OpenAirUsMacSimul OpenAirUsage OpenAirUseCases OpenAirinterface OpenVZSetup QuemuSetup RadioEmulation RemoteOAIAccess RemoteRadioHead RtLinux SIMInfo SchedulerAPI SecondMeasurement SimCardConfig Simulators SmbvTesting SuccesiveInterferenceCancellation T TDDCalib TODO TestMe TransmissionMode4 UserGuide Userguide UsingCbmimo1 VirtualEmul3NodesIPv4 WikiUsage commonconfig enbconfig fairRR scheduler and multiple UEs extensions fembms functest docker setup home how to connect cots ue to oai enb via ngfi 2rru how to connect cots ue to oai enb via ngfi rru how to connect oai ue to cmw how to establish dedicated bearers how to offload turbo decode to fpga how to perform a x2 ho how to run oaisim with multiple ue how to setup oai with lmsdr howtoconnectcotsuetooaienbviangfirru install juju on ubuntu intstall_juju_on_ubuntu joid_on_single_machine m cord oai nFAPI howto networks setup new epc docker oai policies home oai_ue_test_setup.md opnfv fuel opnfv functest s1 flex conf nnsf setup for real time performance uestartup up squared pro cots ue setup usage
Clone
1
WikiUsage
Cedric Roux edited this page 2016-01-21 13:11:28 +01:00
Table of Contents

How to edit the wiki

These "rules" are soft rules. The goal is to have a well structured wiki, easy and quick to edit.

Input format of pages

It is preferable to use the Markdown format to edit your pages.

The Markdown documentation is very small. It is available here.

Try to avoid the use of direct HTML formatting in your pages.

To link to some resource existing in the wiki, use local links, not global ones (starting with http:// or whatever). Links to other resources may obviously be global.

Quick edit

If you want to quickly edit an existing page on the wiki, the easiest way is to click the button edit on the top right.

It would be nice, but it's not absolutely necessary, to write some meaningful comment in the Commit message field, to help tracking changes.

Long edit

If you want to write some new complex wiki page, the best option is to clone the wiki repository, edit and preview locally, and then use the git machinery to commit and push changes back to the server.

To clone the wiki git repository, click Git Access on the top of the page.

Local server (for linux)

In the git repository is a folder tools that contains a basic web server (in tools/miniserver).

Run it and access your local copy of the wiki on http://localhost:8000/home

This allows you to quickly see how your pages are rendered. It should render your pages more or less as the production server does.

Refer to the documentation included within the mini server for more information. If it does not work, contact us.

About attachments

If you want to add an attachment to a page, it is preferable to use the git machinery (git add / git commit / git push) and use sub-directories. If your page is called MyPage.md then put the attachments in the sub-directory MyPage. You can then refer to them with the syntax [this is an attachment](MyPage/attachment.xyz).

You may use the button Attach a file that you see when you edit the page directly on the server. But then the file will not be put in the wiki git repository and it's harder to track it. Avoid this method if possible.