Improving FusionPBX Documentation: Cleaning Up Outdated Links

B

bradgarrison

Member
Feb 20, 2023
47
9
8
49
When searching for FusionPBX documentation on Google, the top results are outdated and can be misleading for users looking for up-to-date information. Here are some examples:
  1. Welcome to FusionPBX Docs — FusionPBX Docs master 文档
  2. FusionPBX
  3. FusionPBX Documentation
These links all appear on the first page of Google search results, but none provide current or reliable documentation. This can be frustrating for users and potentially damaging to FusionPBX's reputation.

Could these outdated links be removed and replaced with updated resources? This would go a long way toward supporting the community and helping new users find accurate, relevant information.
 
  • Like
Reactions: markjcrane, ou812 and Endearing_PBX
E

Endearing_PBX

New Member
Dec 9, 2024
2
0
1
I completely agree. Unfortunately, I've had better results asking A.I. than searching for documentation, which shouldn't be the case.
 
B

bradgarrison

Member
Feb 20, 2023
47
9
8
49
Hi Mark @markjcrane,
Could you take a look at this? It helps explain why so many people are encountering issues with documentation. At least two of the three seem to be within your domain, so they should be straightforward to address. The first one appears to be someone who previously worked on the project—I'm sure there’s a contact for him somewhere.
 
M

markjcrane

Active Member
Staff member
Jul 22, 2018
532
184
43
50
Sure, First of all here are some helpful links about this topic.


Official FusionPBX Documentation and correct URL
https://docs.fusionpbx.com/en/latest/other.html

The documentation is currently in the ReStructuredText (RST) format. Those files are hosted on Git Hub.
https://github.com/fusionpbx/fusionpbx-docs

History of the changes in the documentation. You can see there have been changes in 2025, and 2024.
https://github.com/fusionpbx/fusionpbx-docs/commits/master/

History of the Pull Requests
https://github.com/fusionpbx/fusionpbx-docs/pulls?q=is:pr+is:closed

A New documentation format.
I'm considering migrating the documentation from RST format to Markdown format.
Markdown format is easier and more popular today than the RST format.


Thanks for asking these questions. It appears that the clarification is needed.

1. Welcome to FusionPBX Docs — FusionPBX Docs master 文档
Click to expand...
  • This is an out-of-date copy of the documentation
  • This is the wrong URL.
    • It isn't the official documentation this is an updated copy.
  • GitHub allows making copies of the FusionPBX documentation.
    • This proves that this is both good and bad.
    • It's bad because you are looking at an old copy.
2. FusionPBX Wiki
Click to expand...
The wiki was replaced by https://docs.fusionpbx.com. It was put up again because of social pressure from this forum. I believe that it ironically hurts FusionPBX because the wiki is ancient and no one is updating it. There is no reason to update it as it was replaced. The public documentation was moved to GitHub.

The wiki uses SQLite the database can get corrupted. Your message here proves to me that wiki.fusionpbx.com is harming the FusionPBX project rather than helping it. I'll look through it for information that is still relevant then make a backup of it and then take it down.

3. FusionPBX Documentation PDF
Click to expand...
The PDF file was built by readthedocs.org which runs the servers. They have a Python code that formats the RST files to the PDF and to the web pages that are seen on https://docs.fusionpbx.com. Readthedocs is used to create the PDF automatically without any additional work.
 
Last edited:
DigitalDaz

DigitalDaz

Administrator
Staff member
Sep 29, 2016
3,077
579
113
I know I'm on of the people who pushed for the reinstatement of the wiki at that time, I'm actually suprised that it is still up now. That was long before the documentation was as extensive as it now is. At the time, there was a lot of very relevant information though I wouldn't dream of using it now.
 
  • Like
Reactions: markjcrane
M

markjcrane

Active Member
Staff member
Jul 22, 2018
532
184
43
50
Len used to work for FusionPBX. I paid him to work on the documentation and help with support. He started getting to know the FreeSWITCH team, and he took a job at Signalwire some years ago and still works there.

Currently, two members of the FusionPBX team volunteered to help with public documentation in addition to their other duties. I will also continue to help improve the public documentation.

I also appreciated @bradgarrison your efforts and other people who have helped with documentation past, present and future.
 
You must log in or register to reply here.
Top Bottom