Hi all,
it feels like the state of documentation has deteriorated since the last time I've used mbedtls (a couple of months ago). I'm not sure if the google index hasn't fully been updated yet, or I don't understand the new structure of the docs or ...
Also, is this the proper forum to make suggestions? Should I raise an issue on Github?
1.) a lot of previously linked, useful information now redirects here: https://www.trustedfirmware.org/projects/mbed-tls/ which (please excuse my frankness) feels like an utterly useless abomination that only marketing people could love.
- Some examples of previously useful links: from the wiki ( https://developer.trustedfirmware.org/w/mbed-tls/) :
Old Mbed TLS website Documentation: Mbed TLS API Reference; Knowledge base; Dev corner
all redirect to trustedfirmware.org ! As do nearly all the links in https://github.com/Mbed-TLS/mbedtls/blob/development/SUPPORT.md
2.) there is no longer an doxygen generated API documentation anywhere only. I could generate it myself, but then I'd need to get and install Doxygen, figure how to use it, etc. It would be great if this were restored. It can't be that expensive to host :)
Anyway, it feels like I've been running around for hours trying to find _anything_ useful, but I just realized everything is redirected to trustedfirmware.org ... Is there any way to still access the old, useful docs?
Thanks & sorry that this post is so negative, -tim
I fully agree! I'm also missing a lot of details. The new pages are somewhat ridiculous.
On 07.07.22 14:17, Tim Becker via mbed-tls wrote:
Hi all,
it feels like the state of documentation has deteriorated since the last time I've used mbedtls (a couple of months ago). I'm not sure if the google index hasn't fully been updated yet, or I don't understand the new structure of the docs or ...
Also, is this the proper forum to make suggestions? Should I raise an issue on Github?
1.) a lot of previously linked, useful information now redirects here: https://www.trustedfirmware.org/projects/mbed-tls/ which (please excuse my frankness) feels like an utterly useless abomination that only marketing people could love.
- Some examples of previously useful links: from the wiki
(https://developer.trustedfirmware.org/w/mbed-tls/) :
Old Mbed TLS website Documentation: Mbed TLS API Reference; Knowledge base; Dev corner
all redirect to trustedfirmware.org http://trustedfirmware.org ! As do nearly all the links in https://github.com/Mbed-TLS/mbedtls/blob/development/SUPPORT.md
2.) there is no longer an doxygen generated API documentation anywhere only. I could generate it myself, but then I'd need to get and install Doxygen, figure how to use it, etc. It would be great if this were restored. It can't be that expensive to host :)
Anyway, it feels like I've been running around for hours trying to find _anything_ useful, but I just realized everything is redirected to trustedfirmware.org http://trustedfirmware.org ... Is there any way to still access the old, useful docs?
Thanks & sorry that this post is so negative, -tim
Hi Tim/Frank,
We are aware of the issue and still working on making the documentation available again. We aim to get all the material back online. It might not happen at once: we are planning to make the first bits available soon and the rest will be added back gradually over time.
Thank you both for your interest in Mbed TLS and for your patience.
Kind regards, Janos
From: Frank Bergmann via mbed-tls mbed-tls@lists.trustedfirmware.org Date: Thursday, 7 July 2022 at 13:25 To: mbed-tls@lists.trustedfirmware.org mbed-tls@lists.trustedfirmware.org Subject: [mbed-tls] Re: State of documentation I fully agree! I'm also missing a lot of details. The new pages are somewhat ridiculous. On 07.07.22 14:17, Tim Becker via mbed-tls wrote: Hi all,
it feels like the state of documentation has deteriorated since the last time I've used mbedtls (a couple of months ago). I'm not sure if the google index hasn't fully been updated yet, or I don't understand the new structure of the docs or ...
Also, is this the proper forum to make suggestions? Should I raise an issue on Github?
1.) a lot of previously linked, useful information now redirects here: https://www.trustedfirmware.org/projects/mbed-tls/ which (please excuse my frankness) feels like an utterly useless abomination that only marketing people could love.
- Some examples of previously useful links: from the wiki (https://developer.trustedfirmware.org/w/mbed-tls/) :
Old Mbed TLS website Documentation: Mbed TLS API Reference; Knowledge base; Dev corner
all redirect to trustedfirmware.orghttp://trustedfirmware.org ! As do nearly all the links in https://github.com/Mbed-TLS/mbedtls/blob/development/SUPPORT.md
2.) there is no longer an doxygen generated API documentation anywhere only. I could generate it myself, but then I'd need to get and install Doxygen, figure how to use it, etc. It would be great if this were restored. It can't be that expensive to host :)
Anyway, it feels like I've been running around for hours trying to find _anything_ useful, but I just realized everything is redirected to trustedfirmware.orghttp://trustedfirmware.org ... Is there any way to still access the old, useful docs?
Thanks & sorry that this post is so negative, -tim
--
Frank Bergmann, Pödinghauser Str. 5, D-32051 Herford, Tel. +49-5221-9249753
SAP Hybris & Linux LPIC-3, E-Mail tx2014@tuxad.demailto:tx2014@tuxad.de, USt-IdNr DE237314606
http://tdyn.de/freel -- Redirect to profile at freelancermap
http://www.gulp.de/freiberufler/2HNKY2YHW.html -- Profile at GULP
Janos Follath via mbed-tls mbed-tls@lists.trustedfirmware.org wrote: > We are aware of the issue and still working on making the documentation > available again. We aim to get all the material back online. It might > not happen at once: we are planning to make the first bits available > soon and the rest will be added back gradually over time.
So did some marketing person attack the web site then? Maybe the recent ARM personnel issues means a person inexperienced with this community got involved.
I am not a fan of many Doxygen generated documentation sets, and I've wandered around that part without learning anything for hours. So, it might be reasonable to think that really poor documentation is worse than no documentation, but I'm not sure we were really at that point.
tim> 1.) a lot of previously linked, useful information now redirects tim> here: https://www.trustedfirmware.org/projects/mbed-tls/ which tim> (please excuse my frankness) feels like an utterly useless tim> abomination that only marketing people could love.
Also, a huge SEO loss.
Hi Michael,
This was an unintended change. We had a series of unforeseen issues with hosting.
The website where tls.mbed.org redirects at the moment has been available for years at https://www.trustedfirmware.org/projects/mbed-tls/ and its creation and content is independent from the current issue. The redirection was intended as a temporary measure.
That said, in the future the TF.org website might or might not be part of what will be found under tls.mbed.org. But either way, the documentation will be available there and we are looking into solutions for making the old links work again as well.
Kind regards, Janos
On 07/07/2022, 16:19, "Michael Richardson" mcr@sandelman.ca wrote:
Janos Follath via mbed-tls <mbed-tls@lists.trustedfirmware.orgmailto:mbed-tls@lists.trustedfirmware.org> wrote: > We are aware of the issue and still working on making the documentation > available again. We aim to get all the material back online. It might > not happen at once: we are planning to make the first bits available > soon and the rest will be added back gradually over time.
So did some marketing person attack the web site then? Maybe the recent ARM personnel issues means a person inexperienced with this community got involved.
I am not a fan of many Doxygen generated documentation sets, and I've wandered around that part without learning anything for hours. So, it might be reasonable to think that really poor documentation is worse than no documentation, but I'm not sure we were really at that point.
tim> 1.) a lot of previously linked, useful information now redirects tim> here: https://www.trustedfirmware.org/projects/mbed-tls/ which tim> (please excuse my frankness) feels like an utterly useless tim> abomination that only marketing people could love.
Also, a huge SEO loss.
Janos Follath Janos.Follath@arm.com wrote: > This was an unintended change. We had a series of unforeseen issues > with hosting.
:-(
I'm sure that many us are willing to help if the powers that be can permit such a thing.
Hi all,
Did you know about the internet archive wayback machine? It is a must remember tool! It regularly caches websites. There is a snapshot also of the mbedtls knowledgebase from this April: https://web.archive.org/web/20220428091609/https://tls.mbed.org/kb I think this will help many of you until the official website is restored. Dynamic functions do not work (e.g. searching), but the links and menu works (most things that were available by clicking).
With regards, Gergely
Michael Richardson via mbed-tls mbed-tls@lists.trustedfirmware.org ezt írta (időpont: 2022. júl. 7., Cs, 21:22):
Janos Follath Janos.Follath@arm.com wrote: > This was an unintended change. We had a series of unforeseen issues > with hosting.
:-(
I'm sure that many us are willing to help if the powers that be can permit such a thing.
-- mbed-tls mailing list -- mbed-tls@lists.trustedfirmware.org To unsubscribe send an email to mbed-tls-leave@lists.trustedfirmware.org
Hi Gergely,
Thanks for sharing the archive URL https://web.archive.org/web/20220428091609/https://tls.mbed.org/kb for the old mbedtls knowledge base. This is very useful before the new documentation system is ready.
Thanks, Max
Thank you, that is very nice of you and feels good to hear, but it looks like it won’t be necessary: The plan is to move all the documentation to Read the Docs.
On 07/07/2022, 20:22, "Michael Richardson" mcr@sandelman.ca wrote:
Janos Follath <Janos.Follath@arm.commailto:Janos.Follath@arm.com> wrote: > This was an unintended change. We had a series of unforeseen issues > with hosting.
:-(
I'm sure that many us are willing to help if the powers that be can permit such a thing.
mbed-tls@lists.trustedfirmware.org