Git Product home page Git Product logo

jamulussoftware / jamuluswebsite Goto Github PK

View Code? Open in Web Editor NEW
16.0 16.0 79.0 46.23 MB

This is the GitHub Pages repository for the Jamulus main website. For the jamulus application source code, please visit jamulussoftware/jamulus.

Home Page: https://jamulus.io

License: GNU Lesser General Public License v2.1

HTML 65.77% Ruby 0.43% CSS 13.77% JavaScript 1.54% Shell 16.55% NASL 1.94%
jamming jamulus jekyll music online website wiki

jamuluswebsite's People

Contributors

ann0see avatar birkeeper avatar bugith avatar dominikschaller avatar dzpex avatar ewarning avatar gegeweb avatar gilgongo avatar github-actions[bot] avatar henkdegroot avatar hoffie avatar ichbestimmtnicht avatar ignotus666 avatar imgbot[bot] avatar imgbotapp avatar jdrage avatar jujudusud avatar leoinlios avatar matthiasliermann avatar mcfnord avatar mulyaj avatar npostavs avatar pljones avatar rdica avatar robert53844 avatar smusmu avatar tackin avatar trebmuh avatar vdellamea avatar ve3meo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

jamuluswebsite's Issues

[Guideline] Spelling of documentation in English

Reading through the documentation in English, particularly the new text that's being drafted, I see the need for an in-depth revision to correct a wide variety of mistakes (grammar, syntax, misspellings, typos...). I can volunteer to do that (if @gilgongo is ok with it) but I'd rather wait until the new changes settle in as it seems to still be an ongoing process. This would simply be a revision to correct mistakes and would not entail any changes to content, so translations would be unaffected.

But regardless of who does the revision and before tucking into it, I think we ought to decide what spelling we're going to use: en-US or en-GB, and be consistent with it. Spelling for the GUI is in en-US - I'm not sure how consistent it actually is but Volker asked for it to be that way. As regards what to use for the documentation, I have mixed feelings - on the one hand I (and also @gilgongo if I'm not mistaken) speak and write in GB English. In my work, unless explicitly asked to do otherwise, I'll always write/proofread in en-GB. But on the other, I understand that our English-speaking audience is much wider than just the British Isles. I suspect most people wouldn't care or notice either way, but I do think there should be consistency. I recently saw a bit of text where 'minimise' is used, and then a couple of lines down it's spelled as 'minimize' - in fairness it's mainly due to occupational habit, but these things make me wince involuntarily.

I haven't done a thorough check, but I think that as @gilgongo wrote most of the documentation it's mostly in en-GB already. My personal preference would be to keep it that way, but it's not a hill I'm going to die on.

So, what are your thoughts?

[Feature]

To show pings of users in connect window.

Is this possible with out too much overhead?

[Feature] Make wiki structure more understandable by using a link which shows parent pages (breadcrumb)

Is your feature request related to a problem? Please describe.
Currently if you are on a wiki page for the first time, it might be confusing if you clicked through multiple pages and are lost in the structure. e.g. if you are on the Choosing-a-server-type page you might be confused where you are and don't know how to come back since the navigation doesn't link this page.

Describe the solution you'd like
It would be great to have a breadcrumb or something similar like in the current issue.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
Add a breadcrumb to every page manually (this is not a clean solution)
Additional context
See this:
Screenshot_2020-10-25 corrados jamulus

Jamulus code signing – Jamulus safety

Describe the bug
During my SEO checking around Jamulus I came across the question "Is Jamulus is safe". If you download it from the original source (SourceForge) or compile it on your own, it is (there’s no virus/malware included), at least from my point of view.

I think people search for this because of the missing code signature (Windows defender Smartscreen, macOS gatekeeper).

I‘ve made the Windows & Mac install pages a bit clearer (see changes branch).

Could you please check the wording and make it a bit clearer?

[Bug] Make tables responsive

URL
Please provide the url where you experienced the bug if there's one.
https://jamulus.io/de/wiki/Network-Requirements
Describe the bug
A clear and concise description of what the bug is.
The table on mobile devices overflows the view port. This is a typical issue on mobile devices.
To Reproduce
Steps to reproduce the behavior:
Visit a site which includes a table on a small device

Expected behavior
A clear and concise description of what you expected to happen.
Display the table in a responsive way
Screenshots
If applicable, add screenshots to help explain your problem.
Screenshot_2020-10-25 Quality, Delay and Network Bandwidth – Jamulus Wiki

Additional context
We should discuss which solution we want. An external JS library? A scrollable div?

[Feature] Implement search engine

Is your feature request related to a problem? Please describe.
Currently it's quite challenging to find pages which are not in the navigation. Therefore I suggest to add a search function. Since jekyll is static, we can't do server side search.

Describe the solution you'd like
I looked into https://learn.cloudcannon.com/jekyll/jekyll-search-using-lunr-js/ which might work
Describe alternatives you've considered
https://github.com/christian-fei/Simple-Jekyll-Search

Breaks the site
Additional context
None

[Bug] Incorrect structure for navigation

As you can see in the screenshot below (using w3m) a new list item is created after the h3title.
The 'li' should not be closed after the 'h3' and not reopeened before the unordered list for submenu.

Capture d’écran 2020-11-24 à 13 14 34

Here is the output of the good structure (I'll open a MR) with the fix below:
Capture d’écran 2020-11-24 à 13 57 13

Capture d’écran 2020-11-24 à 14 15 43

<aside id="gnav" class="fx-col-100-xs fx-col-25-m">
	{% include langselect.html %}
	<nav id="mnv">
		<ul>
			{% if site.data.navigation.nav[0] %} {% for item in site.data.navigation.nav %} {% if item.url %}
			<li>
				<h3><a href="{{ item.url | relative_url }}" class="{% if subentry.url == page.url %}selected{% endif %}">{{ item.title }}</a></h3>
				{% else %}
				<li>
					<h3>{{ item.title }}</h3>
					{% endif %} {% if item.subfolderitems[0] %}
					<ul>
						{% for entry in item.subfolderitems %}
						<li><a href="{{ entry.url }}" class="{% if entry.url == page.url %}selected{% endif %}">{{ entry.page }}</a> {% if entry.subsubfolderitems[0] %}
							<ul>
								{% for subentry in entry.subsubfolderitems %}
								<li><a href="{{ subentry.url }}" class="{% if subentry.url == page.url %}selected{% endif %}">{{ subentry.page }}</a></li>
								{% endfor %}
							</ul>
							{% endif %}
						</li>
						{% endfor %}
					</ul>
				</li>
				{% endif %} {% endfor %} {% endif %}
		</ul>
	</nav>
</aside>

[Feature] Rethink server setup

This should be worked on AFTER we merged #101

Is your feature request related to a problem? Please describe.
Currently the server setup is too wordy and (at least in my opinion) not easy to follow. We should rethink it in a "do this and that" style, especially the private server setup is a bit confusing since it doesn't really explain what to do. Setting up a server isn't as difficult as depicted there.

Describe the solution you'd like
Rethink the server setup; focus more on setting up a private server.

  1. Remove the servertypes page and integrate it in the setting up a server page
  2. Add information that you can either use the server icon on macOS/Windows or use the commandline (especially on Linux).

#45 #50

Enhancement of Sound-Devices.md (proposals)

Sound-Devices.md is the only page I haven't pushed for the French translation.
If I understood correctly, this page will be the official page maintained with up-to-date information.
A page on the community area will be completed by the users. Right?

This page should be more structured to be readable and transmit the information correctly, I would suggest the following (as an example):

  • Structured by type
  • Links to the product manufacturer's page (or Wikipedia if exists and discontinued product)
  • emphase (in bold) the OS

Sound Devices

This page lists (thanks to Jamulus users) the audio devices known to work (or not) with Jamulus.
Note: depends on how the device works on your system (Linux, MacOS, Windows, etc.).

You can update it with the information you have. Please indicate the platform(s) you are using!.

Audio devices known to work with Jamulus

USB/USB-C devices

Microphones / DI Boxes

  • Blue Yeti, USB Microphone
    Works well under macOS (there is a check option to disable local monitoring).  
    Works well under Windows 10 with ASIO4All, a bit more latency than under macOS. You can disable local monitoring by going deep into the settings.
    Latency is good under Linux. You can't disable local monitoring (or we haven't found out how to do it, feel free to send us the information if you know how to do it).

  • Shure X2u, USB to XLR audio interface with headphone jack connector that converts a wired microphone to a USB microphone.
    Set the PC/Mix dialog box to 100% PC to listen to Jamulus' mix on the headphone output.
    Tested with a Raspberry Pi 4 under Raspberry Pi OS Buster, kernel version 4.19.

Audio interfaces / digital mixing consoles

  • Solid State Logic SSL2+, USB-C/USB digital audio/MIDI interface 2 in/4 out
    Works great out of the box, almost better than under macOS, with Jamulus under Linux Ubuntu 20.04 (ACER Veriton N, i5, 8GB Ram) with these settings (plugged on a USB3 port), recognized as "SSL2+" by qjackctl, no or very low latency, very good sound (SSL preamplifier!).
    Same under macOS on a Mac Mini (late 2012, i7 / SSD / 8Gb RAM), with more sound dropouts than under Linux (plugged on a USB2 Hub).
    Not yet tested on Windows 10, native ASIO driver
    The monitoring of the Jamulus mix is done by moving the "MONITOR MIX" completely to the right to "USB". See the official manual.

Amp modelers/effects pedals for instruments

Digital recorders

  • Zoom H4, USB portable recorder
    Works well on Mac, PC and Raspberry Pi4

Firewire devices

  • Presonus StudioLive 16.4.2 AI (StudioLive AI series), Firewire digital mixing desk
    Works perfectly with Jamulus under macOS (not yet tested on Big Sure). Assign the individual inputs in Jamulus or the corresponding inputs to a stereo auxiliary mix (to be patched in "Universal Control") if more than two channels. Use outputs 17-18 to monitor the Jamulus mix.
    These devices work under Windows, they should work with Jamulus under this OS (not tested).
    Not tested under Linux, may (or may not) work, see here.

Thunderbolt devices

Internal soundcards

  • HiFiBerry DAC+ ADC, Raspberry Pi compatible HAC internal sound card.
    Virtually no jitter and good latency (20 milliseconds). No headphone amp, so you'll need one. Used with a mini console Rolls MX122. Tested on Raspberry Pi 4 under Raspberry Pi OS Buster, kernel version 4.19.

  • Soundblaster Live!, PCI sound card
    With kX ASIO driver

Audio devices known not to work with Jamulus

  • Zoom B3, USB amplifier modeling pedal for bass. Does not support 48 KHz.

  • Line6 Bass POD, USB amplifier modeling pedal for bass. Does not support 48 KHz.

[Bug] Download icon might be too difficult to reach?

URL
See the windows/macOS install page and the Getting Started page.

Describe the bug

We already talked about this issue but at the moment I have the impression that we might have gone too far.

We want as many people as possible to get through the docs. At the moment this is done by not showing the download button until the users reach the operating system setup pages. This might lead to some people not finding the download link or thinking it’s too difficult to setup Jamulus and to more links to the SourceForge download page.

Ideas
We might add a download button under ”Now that you have the basics down, let’s go:“

Any thoughts on that?

But with a sentence saying that you should read on.

Version control in Jamulus documentation

Currently we suffer from unstructured editing, have different versions in languages,... We should discuss how we solve this problem (= ensure every language is up to date).

To make development easier and faster, @gilgongo suggested to make a new branch.
I think that's a good idea. We could split it into 3 branches:
main: the branch which gets built to github pages. We only submit changes here if everything was approved.
Translation: The step before approval. Here translation begins. No changes
Development: Active development, restructuring,...

So a normal workflow would look like this:

  1. Add a new page (english only): commit to the development branch.
  2. After a period of time it gets merged into translation for the translators
  3. If everything was checked, we merge it into main.

Of course we could also create a "development" and a "translation" branch while the "translation" can not be changed content wise.

Originally posted by @ann0see in #28 (comment)

Another option would be the projects tab on github (we could document changes and todos there).

[Bug] Link to new homepage broken

URL
http://llcon.sourceforge.net/index.html
wrongly redirects to

Describe the bug
If you click the link on the facebook group (https://www.facebook.com/groups/619274602254947/) you get an error and not redirected to jamulus.io. The easiest fix is to change it to https://jamulus.io Who is the admin of this group? I do not have a facebook account.

Nevertheless the issue is broader. Gilgongo already experienced the redirection issue after we uploaded the htaccess file.

I'm unsure but we could also redirect permanent the index.html file. Would that fix the issue?

[Bug] Broken links

https://jamulus.io/de/wiki/Client-Troubleshooting

https://jamulus.io/de/wiki/Hardware-Setup

https://jamulus.io/de/wiki/Server-Linux

https://jamulus.io/de/wiki/Server-Rpi

https://jamulus.io/de/wiki/Server-Win-Mac

https://jamulus.io/de/wiki/Tips-Tricks-More

https://jamulus.io/es/wiki/Client-Troubleshooting

https://jamulus.io/es/wiki/Getting-Started

https://jamulus.io/es/wiki/Hardware-Setup

https://jamulus.io/es/wiki/Installation-for-Linux

https://jamulus.io/es/wiki/Running-a-Server

https://jamulus.io/es/wiki/Server-Linux

https://jamulus.io/es/wiki/Server-Rpi

https://jamulus.io/es/wiki/Tips-Tricks-More

https://jamulus.io/fr/wiki/Hardware-Setup

https://jamulus.io/fr/wiki/Installation-for-Linux

https://jamulus.io/fr/wiki/Running-a-Server

https://jamulus.io/fr/wiki/Server-Linux

https://jamulus.io/fr/wiki/Server-Rpi

https://jamulus.io/fr/wiki/Tips-Tricks-More

https://jamulus.io/it/wiki/Client-Troubleshooting

https://jamulus.io/it/wiki/Command-Line-Options

https://jamulus.io/it/wiki/Hardware-Setup

https://jamulus.io/it/wiki/Installation-for-Linux

https://jamulus.io/it/wiki/Running-a-Server

https://jamulus.io/it/wiki/Server-Linux

https://jamulus.io/it/wiki/Server-Rpi

https://jamulus.io/it/wiki/Server-Win-Mac

https://jamulus.io/it/wiki/Tips-Tricks-More

https://jamulus.io/wiki/Tips-Tricks-More

Stats:
9682 links
227 destination URLs
257 URLs ignored
46 warnings
5 errors

[KB] Add page for setup with video conferencing tool

I think somebody (not me since I have no real experience) should write an article for the upcoming knowledge base about

  1. How to use Zoom or any video conferencing tool with Jamulus
  2. How to setup a virtual audience like WorldJam (chrisrimple?)

Also, is there experience using Jitsi or another open source video conferencing tool (instead of Zoom).

See:
#101 (comment)

Thoughts about information architecture 2.0

The two "Troubleshooting" page are like "FAQ", by the way "FAQ" is already used in the description of some internal links.

What about renaming these "Frequently asked questions (FAQ) – client" and "Frequently asked questions (FAQ) – server"?

Then we open the door to no technical problems with questions I've seen in other places like:

"What is the best practice when joining a jam session?" (for example)

Create "image library"

Currently there are not many screenshots in the documentation.

I suggest to e.g. add screenshots on the ASIO4All setup.

Nevertheless, there are many more places where we can add some (Installation for Windows/macOS)

[Translate]Index Page

The index Page is not loaded from the wiki folder but from the main folder.
How i can translate it?

[en] consistency: "FOSS", "open source",...

There are several places where it says "open source". It is ambiguous as "open source" doesn't necessarily mean it's free (as "free as a free speech").

Because Jamulus is distributed under a GNU GPL licence, it would then make sense that it should be at least "FOSS" (Free Open Source Software).

If we want to emphasise and disambiguate even further, we can use "FLOSS" or even "libre software" as written and suggested by Stallman on the FSF website.

@corrados : it would make sense for you to share your opinion here.

Strange wording in en-Linux-Install-Script.md

In the end of en-Linux-Install-Script.md, in the paragraph about improvements for the script there is wording that take time to me to understand the meaning for a good translation (and i'm not already sure):

strange wording in emphase below:


The script can ask in the very beginning for which linux distribution the installation script should be called.
This can be tested with the command lsb_release

With the lsb_release command the command returns the distribution specific information about a Linux distro.
With a grep command with regular expression the variable DISTRO and LINVERSION.
E.g. the Ubuntu based systems return with the command the following information.


Seems there is a repetition in the first and missing something in the second.

I would suggest: [edited]


With the lsb_release command wich returns the specific informations about the distro on Linux.
With a grep command using regular expressions for the variable DISTRO and LINVERSION.


Translated in French:


Avec la commande lsb_release qui retourne les informations spécifiques à la ditribution sous Linux.
Avec la commande grepet en utilisant des expressions rationnelles pour les variables DISTRO et LINVERSION.


Good practice for acronym : use a abbr tag with title

As mentioned in #90 and used in fr-Central-Server.mdfor the french translation of GUI, a good/best practice for acronyms is to enclose these inside a <abbr>tag with a title, like this:

<abbr title="JACK Audio Connection Kit">JACK</abbr>

Or this in fr-Central-Server.md:

Serveurs sans <abbr title="Interface utilisateur graphique">IUG</abbr>

That show a help pointer when the mouse is hover and the content of the tootltip wich explain the signification of the acronym.

There is a lot of acronyms in the Jamulus's documentation, so it should be generalized and applied on each acronym.

I have already applied this practice on some pages in French translation for WAN, NAT, IUG...

[Feature] Explain buffer settings

Is your feature request related to a problem? Please describe.

Users coming through the installation guides don't get told know how to handle buffer settings

Describe the solution you'd like

Describe buffer settings on the onboarding page

New Installer: Explain what ASIO is

The new installer is almost ready and linking to https://jamulus.io/wiki/Installation-for-Windows#setting-up-asio4all if no ASIO driver was found. We should explain ASIO on Windows for newbies. (Why they need it [only one sentence], and that ASIO4ALL is not recommended but probably needed. etc.)

Any proposals?
What I'd suggest:

  1. Explain that you need an ASIO driver since the inbuilt drivers don't allow low latency audio
  2. Tell the user that usually ASIO drivers are only provided for external sound cards (which we also recommend to use with Jamulus)
  3. Tell the user that he can use ASIO4ALL which is a generic ASIO driver and the setup is described here (save for later); it should also be possible to download the .md file since sometimes the web browser also conflicts with ASIO4ALL

Rename main branch to release

Is your feature request related to a problem? Please describe.
Currently the name "main" is misleading.

Describe the solution you'd like
I suggest to rename main to something like release to clarify what the branch is for.

Describe alternatives you've considered
We could also name it live or published.

Is it me, or is editing the site content now too difficult?

I've just tried reviewing #108 and realised I was getting pretty confused.

I find it very hard to work out whether proposed changes are going to work. I can review the raw content, but without the relevant UI context, it's like trying to watching a movie where only parts of the screen are visible to you at any one time (and what is visible looks nothing like the director intended).

At the risk of further complicating things - what would happen if we had (yet another) branch for "refactoring" the docs (if that's what we're doing with adding whole new sections and stuff) which we could compile locally to looks at. A fork perhaps? Just some way in which we can see how the site would look and feel with certain changes so we can judge the changes properly. This is going to be even more important if we start incorporating images too.

I think this implies we'd treat that branch like a wiki and just commit directly to it without going though reviews in Github.

Translation doesn't (I assume) suffer from this though, so that can stay the same.

Simplify the Getting Started Page

Is your feature request related to a problem? Please describe.
Currently, I think the "Getting Started" page contains information irrelevant to getting started. For new or potential users, this page is probably the first page they click on after the home page. Thus, it addresses users that have not yet or are about to download and install the software. Therefore, sections like Maximise Quality and Have trouble? Can't keep in time? don't have relevance to the reader since they might not have even used the software yet.

Describe the solution you'd like

The "Getting Started" page should ideally contain:

  • Description of Jamulus
  • System + Hardware Requirements
  • Recommended Hardware (Audio Interface and/or USB mic)
  • Links to installation/set-up on Windows/Mac/Linux

Maximise Quality, Minimize Delay and Having Trouble? Can't keep in Time? sections can be incorporated into the Onboarding page, describing an optimal first-time use of Jamulus.

In context, the flow for a new user would go from Getting Started (Check Hardware + Specs, determine if they can use Jamulus) -> Set-up on their OS (Follow installation steps and setup hardware) -> Onboarding (Learn to use Jamulus optimally)

[en] consistency QT/Qt

Qt should be written like that: Qt (not QT). See https://www.qt.io/product/framework .
I've seen a typo in wiki/en/en-Compiling.md and in its translations:

  • wiki/es/es-Compiling.md
  • wiki/de/de-Compiling.md
  • wiki/fr/fr-Compiling.md

I've made the changes in those files on the "changes" branch but now, I wonder if that wouldn't have been better against "release".

Brevity: Too long vs too short

Currently @gilgongo has the intention to keep the content of the wiki as short as possible. I do agree that we have to remove a lot of duplicates and unnecessary information. Nevertheless, I think some (explaining) information is needed.

Let's have a look at a few examples:

Unless you are a musician with a (USB) microphone, you are strongly advised to use an audio interface: a box that you can plug your instrument(s) into. This will connect to your PC usually via USB. See Hardware Setup.

If I were new to Jamulus, I wouldn't understand why I am "strongly advised to use an audio interface". Does Jamulus want to make money from me? Why do I need to buy this thing??? What is the benefit of this hardware??? Why do they mention a USB microphone? What's that?
You could say something like: "Although you can use your internal soundcard [that's what newbies will probably have], you should consider using a Audio Interface (footnote) to improve quality and delay (footnote). You can also try an USB-Microphone" (Why do we need to link the hardware setup here? Wouldn't "known good hardware" be better?)

Wired headphones - not speakers to prevent echo or feedback and to minimize delay

That's ok. It explains why this is needed in a very short way. If somebody wants to know more, he can have a look at the footnote.

Try to make sure nothing on your machine or your network is competing against Jamulus when you are using it.

Why that?

On Win/Mac:

You can also compile your own binary if you feel so inclined.
Ok. That's interesting. But does it need to be that prominent? Do we need this here? Also: Do we need to link the Guide from Simon Tomlinson multiple times?

Just some thoughts on this. I don't want to discuss the details just bring the message across: we should agree on a general "What is too much, What is not enough" policy.

What I could imagine being good is using the "blog" feature of Jekyll. It would allow contribution like tips/tricks/guides by multiple people which would like to publish there information etc and would reduce links/unneeded edits.

[Bug] footer outdated

In the footer, we have "Summer 2020! Tell us about Jamulus - take our anonymous survey!".
It starts to be outdated (we're not in summer 2020 any more) and we might want to change that to something more up-to-date.

Use scenario-based approach for server type description

When I started working on the French version of Choosing a server type page, I felt the need to specify and explain what the different types of servers were and in what context they could or should be chosen. And especially for the central server type.

So I added an introduction in the spirit of the proposal below.

This could be something like after the main title:


Start by first (re)asking yourself the question(s), do I really need my own server, and if so why do I need it?

The server can be configured in three modes, whether the server is at home or at a service provider (cloud, dedicated server...). The answers to the "why?" below will help you choose:

  1. The Jamulus concept is great! I have the bandwidth or already have a server in the cloud or a dedicated server and I too want to contribute and expand the range of public servers available with low latency in my region.
  2. The concept of Jamulus is great! But... for my band's training sessions, it's annoying to sometimes be disturbed or listened to by others on public servers.
  3. You are, for example, an organization (school, conservatory... ) and want to reference several servers by groups, musical genres or classes administered by your organization, your teachers or your students.

[Translate] English version littered with {: target="_blank" rel="noopener noreferrer"} and some other issues

Hi, I'm working on getting the Spanish version ready and have noticed that the English version is littered with this: "{: target="_blank" rel="noopener noreferrer"}" all over the place. Do I leave them there? Delete them?

Also, I know it has been done with the best of intentions, but I'm seeing a fair few additions in English that contain many mistakes, with some entries being close to unintelligible. E.g. there's a section in Client-Troubleshooting (Try to connect - Message in Jamulus Client on MacOSX) that is virtually unreadable and looks more like a kind of bug report - leaving aside linguistic issues I don't understand what it's purpose is in the wiki. Then there are syntax errors scattered here and there which will require some proofreading.

I'm also seeing that changes keep being made constantly to the files in English—my 2-day-old fork is already obsolete and I'll have to update all the files again to reflect those changes. I think there should be a "feature freeze" before encouraging translations because otherwise we just keep playing catch-up with an ever-moving target. I know there's a lot going on but I think we should use a more structured approach than the current scattergun one—e.g. bundle edits and commit them on a weekly or fortnightly basis after reviewing them carefully.

What do you guys think?

[Translate] Degree of interpretation for translated content

This issue should discuss how far interpretation of the English version should go in translations.

For me I think these main points have to be considered:

What is the translation for?

  • A non English speaking person should understand the same as if he read the English version and think the text was written in his native language.

For me this means that:

  1. The translation should be based on the English version and should not add more information (if you want to, add it to the English version)
  2. The translated version should not sound like an English text in the language we translate it to. This means that terms like "headless" can't be translated into something like "without head". The text should sound like it was written in the language we translate it to. Therefore although the content is similar, we do not need to use the exact same words.
  3. Concerning guides, links, ... to pages in the language we translate to: I'd strongly advise to link to pages in this language, not English if the quality is ok.

[Feature] Android installation explanation

Is your feature request related to a problem? Please describe.

GitHub actions is going to provide apk builds thankss to @nefarius2001 jamulussoftware/jamulus#880 (comment)

Describe the solution you'd like

A page (like for windows installation) which tells the user how to install the APK but also tells him that it's in early beta

Describe alternatives you've considered

We could also not mention it since it's not 100% stable yet (but you can listen at least).

si cantas o tocas instrumentos acústicos, para asegurarte de que mantienes el ti...

[^2]: Los auriculares Bluetooth normalmente tienen demasiada latencia. Esa es una razón por la que se necesitan auriculares por cable. Sobre todo si cantas o tocas instrumentos acústicos, para asegurarte de que mantienes el tiempo con los demás, utiliza solo auriculares (ver la [nota sobre esto](Getting-Started#tienes-problemas-no-puedes-mantener-el-tiempo) para más información).


This issue was generated by todo based on a todo comment in 2f1f332. It's been assigned to @ignotus666 because they committed the code.

[Bug] Running-Jamulus-with-Multiple-Audio-Interfaces page

https://jamulus.io/wiki/Running-Jamulus-with-Multiple-Audio-Interfaces#linux

The link "Follow this tutorial to route the desired interface into Jack by using alsa_in." isn't linking to a relevant page any more. We can replace it with a link from archive.org : https://web.archive.org/web/20201112033306/https://www.penguinproducer.com/Blog/2011/11/using-multiple-devices-with-jack/ or we can find another tutorial.

I'd go with the archive.org link.
Thoughts?

[Feature] More Vocal options for Choir down the intstrument profile in My profile

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
In a choir you have more different vocal options than in traditional barbershops (Soprano, Alto, Tenor and Bass). We have two options for Alto and Soprano = Alto 1 and Alto 2 and Soprano 1 and Soprano 2. This helps us to create groups in Jamulus and use the panorama button so that we can create the same feeling as in the room You stand in reality.

Describe alternatives you've considered
We want more choices under the menu for instruments for us who use Jamulus for our choir rehearsals. Today there is singing in the form of Soprano, Alto, Tenor and Bass. We need to divide Alto and Soprano respectively into Sopranos 1 and 2 and Alto 1 and 2, as there are divided parts in a choir.

Additional context
Vocal (soprano)
Vocal (soprano 1)
Vocal (soprano 2)
Vocal (alto)
Vocal (alto 1)
Vocal (alto 2)

I think soprano and alto without division need to remain for those who do not divide soprano and alto parts into 1 and 2 respectively

Server-Win-Mac.md : about system FW under MacOS or Windows.

When I first worked on the French translation (no new merge request yet) of the Server-Win-Mac.md page, I noticed the lack of mention about application firewalls.

On both systems, if the system firewall is active, at the first use of the server (GUI) an alert asks if you want to allow incoming connections for the application.
Of course, you have to confirm for it to work.

So I had a note like the following for the both: (my english may be no good)


  • Windows users - Start the server using the entry for "Jamulus server" in the Windows start menu.
    Note: If you have an alert asking you to allow incoming connections for the Jumulus application, you must awnser yes to the question

  • Macintosh users - Double-click the "Jamulus server" icon in Applications (assuming you put the files from the install there as per these instructions).
    Note: If you have an alert asking you to allow incoming connections for the Jumulus application, you must awnser yes to the question


Improvement for Contribution.md

As discuted on #46 hompage will now be linked to the Contribution.mdpage.
The content of this page is really succinct for the moment.

This page talk about two distincts things.

  • contribution to the documentation (come from the link on the footer of the doc)
  • contribution to the software himself

Perhaps it could be subdivised and linked to two distinct guidelines pages, one for contributing to the code, one for contributing to the documentation.

In introduction it must explain what is the differents channel of communication and contribution, especially explain the behavior of the forums on sourceforge.

I've some ideas. I can make a merge request if you agree (but before, I think I'll continue to work on the french translation when the first pages will be merged, I'm looking forward of it!).

[Translate] - IT Coordination

Hi ann0see. I had problem with my pc in the next day i will continue it trans.

In these days i had thinked that if there are any change in original language page is necessary create an allert for replicate the changes in other langua page .....

How do you think about?

[en] consistency: audio interface / sound card / ...and others

Another consistency wording across the documentation.

The texts are written sometimes with one, sometimes with another of the following:

  • audio interface
  • soundcard
  • sound card
  • sound device
  • sound interface
  • audio device
  • audio card

From what I have been able to see, there is no difference in meaning in the use of one or the other in the texts on the pages of jamulus.io .

I suggest here that we choose one so as not to disturb readers (especially beginners) who might wonder if there is a difference between "sound card" and "audio interface" in our texts. I suggest "audio interface" because it is the most neutral and encompassing of terms.

Thoughts?

[Feature]

What should the overall ms be local?

Someone said to me they had 8ms a while ago but even at 32buffers I still have 16ms.

Refer to "macOS" not "Macintosh" in the documentation

Good Morning to all (It's morning here at this time),

sorry in advance for my english here (not checked if it is good), there is an emergency! ;)

I'm working on the french translation. At this time working on fr-Server-Win-Mac.mdbefore launch reviewing.

And I've a big problem to follow the rule and keep in close to the original english version (In fact, I really can't) because using « Macintosh » is wrong. First, since 1998 this family computers is named « Mac ». But the most important thing is that « Macitosh » or « Mac » is for designing a family of personal computers, not an OS.
Using « Macintosh » is as using « PC » without take care about the operating system (Windows can be installed on a Mac (since Intel processor), GNU/Linux and *BSD too…).

So "Instalation for Macintosh" is not correct and even more "Installation for Windows1 and Macintosh".

That must be "Installation for Windows an macOS" or "Installation for Windows and Mac OS X or macOS" if Jamulus works on Apple OS < 10.15. Everywhere « Macintosh » is used.

See the Wikipédia French page : « Ne doit pas être confondu avec Mac OS, macOS ou Adresse MAC »
Not to be confused with Mac OS, macOS or MAC address

In the near futur we probably should take care about processor too because the new M1 processor. I don't know if Jamulus have been compiled and tested on a Mac with macOS and M1 processor. (waiting for feedback here jamulussoftware/jamulus#749)

So for the French version, we must make an exception to the rule and fix the "bug" already, EN version must be fixed too. That's a « bug » with a high priority that must be fixed quickly as possible! (in all the branchs)

Notes:

  • aside, I think an exception to the rule should also be make for the Index page
  • there is other forgot or mistake about macOS or Mac OS X, but that can be fixed later, no high priority

Footnotes

  1. about Windows: perhaps should be « Windows 10 and later » (doesn't works on Windows 7 and early)
    As you see we don't say « Installation for PC » here (Mac family are PC (Personal Computer) too)

Improvement for CONTRIBUTING.md

Actual version of CONTRIBUTING.md is verry short!


Contribute

Thanks for your support! Please open a pull request on GitHub!


I based myself on this rule when starting to work on the French translation, you can see what kind of misunderstanding it caused! ;)

I propose (i could open a MR if you agree) something like (not sure for my english!):


Contribute to the documentation

Thanks for your support! You're welcome!

  • First, take a look at the issues to check if there already one on the same subject.
    If yes, you can join the discussion adding your comment.

  • If no, start by openning a new issue with your proposal.

  • Then, you can submit your merge request with your adds or changes following the rules explained here and below:

    • If not doing yet, fork this repository
    • create a new branch from the up to date changes branch
    • make your changes
    • push the new branch into your repository
    • submit the merge request linking to the opened issue from your branch to the changesbranch.
    • wait for the review and the merge…

DO NOT MERGE YOUR WORK into your local changesbranch, only keep it in sync by pooling from the remote Jamulus repository.
DO NOT WORK ON your local changes branch, always works from a new branch.
If the changesbranch is modified before submitting your request, keep the local changesbranch in sync by pooling from it, merge the local changes branch into your working branch, resolve conflicts and then push your changes and create the merge request.

Please note that all the discussions are in English. If it is not you're native language and are not fluent with it, it can dissuade you. Don't be afraid, you can use DeepL wich make good translations as a help support.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.