Re: [asterisk-dev] issues-archive.asterisk.org is now available for preview

[Joshua C. Colp]

On Fri, Aug 4, 2023 at 4:14 PM George Joseph  wrote:




>
>>
>> I don't know that the hosted archives needs to do this, I suspect very
>> few people would have any need for being able to do that, and I don't
>> want to add any work for anyone here.
>>
>> Side question, more on the legal side. When everything was on JIRA, I
>> think the policy was that any patches on JIRA could be taken through
>> code review by anyone else, so long as the uploader had signed the CLA.
>> Now that it is on GitHub, and there is a new CLA, and most people have
>> not resigned the CLA for patches from the past ~20 years, how does this
>> affect patches in the JIRA archive? Since the CLA was valid when they
>> were provided to the project, can they still be taken through code
>> review by anyone else? What is the status of such patches? Thanks.
>>
>
> I'll have to let Josh answer that one.
>

The patches can not be taken as-is, the creator has to sign the new CLA.
All old signatures are no longer valid.

-- 
Joshua C. Colp
Asterisk Project Lead
Sangoma Technologies
Check us out at www.sangoma.com and www.asterisk.org
-- 
_
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-dev

Re: [asterisk-dev] Final Preview: docs.asterisk.org

[asterisk]

On 8/4/2023 3:20 PM, George Joseph wrote:
On Fri, Aug 4, 2023 at 11:50 AM > wrote:


Only thing I noticed when building this time around was warnings
like these:
INFO    -  Doc file

'Asterisk_20_Documentation/API_Documentation/Dialplan_Functions/SMDI_MSG_RETRIEVE.md'

contains an absolute link
'/Asterisk_20_Documentation/API_Documentation/Dialplan_Functions/SMDI_MSG',

it was left as is. Did you mean 'SMDI_MSG.md'?
INFO    -  Doc file

'Asterisk_20_Documentation/API_Documentation/Dialplan_Functions/STREAM_SILENCE.md'

contains an absolute link

'/Asterisk_20_Documentation/API_Documentation/Dialplan_Applications/ChanSpy',

it was left as is. Did you mean
    '../Dialplan_Applications/ChanSpy.md'?


Since I don't get those errors I assume they're your own added 
documentation?  I can't really help there.  All I can say is to look 
at how the standard documentation references other pages.  To make 
sure the links work in different versions of asterisk, they need to be 
relative, like the last error message above.


No, I was seeing this for everything (e.g. ChanSpy and SMDI_MSG_RETRIEVE 
above). But if you're not getting them, then maybe I (probably) missed 
something. Since everything worked regardless, I don't think we need to 
worry about this then. If I notice an actual issue down the line, I'll 
look into that and flag if needed, but right now all's good.


--
_
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
  http://lists.digium.com/mailman/listinfo/asterisk-dev

Re: [asterisk-dev] Final Preview: docs.asterisk.org

[George Joseph]

On Fri, Aug 4, 2023 at 11:50 AM  wrote:

> On 8/4/2023 9:42 AM, George Joseph wrote:
> > Well, I've made a few more changes and pushed them up.  I think this
> > is as good as it's going to get for now.
>
> I think it's perfect. Down from 230 MB to 140 MB for the same build. 40%
> size reduction just by removing whitespace I guess! Looking at a few
> pages manually, the HTML looks perfect. No visible issues.
>
> Only thing I noticed when building this time around was warnings like
> these:
> INFO-  Doc file
> 'Asterisk_20_Documentation/API_Documentation/Dialplan_Functions/SMDI_MSG_RETRIEVE.md'
>
> contains an absolute link
> '/Asterisk_20_Documentation/API_Documentation/Dialplan_Functions/SMDI_MSG',
>
> it was left as is. Did you mean 'SMDI_MSG.md'?
> INFO-  Doc file
> 'Asterisk_20_Documentation/API_Documentation/Dialplan_Functions/STREAM_SILENCE.md'
>
> contains an absolute link
> '/Asterisk_20_Documentation/API_Documentation/Dialplan_Applications/ChanSpy',
>
> it was left as is. Did you mean
> '../Dialplan_Applications/ChanSpy.md'?
>
>
Since I don't get those errors I assume they're your own added
documentation?  I can't really help there.  All I can say is to look at how
the standard documentation references other pages.  To make sure the links
work in different versions of asterisk, they need to be relative, like the
last error message above.


> However I tested the site and things seem to work fine. The build did
> take longer, possibly due to the above checks, 90 seconds vs 18, but
> that's not really an issue. The links do appear to be relative to me -
> I'm not putting this in a domain root, but in a subfolder, and the links
> all seem to work correctly for me. So I don't think there's an issue and
> it seems like this can be ignored - perhaps it went ahead and converted
> it on the fly. Just wanted to point that out in case I'm wrong.
>
> Everything seems to work well, I don't see any further issues with
> anything here. Thanks a lot George for looking into these issues, I'm
> looking forward to porting documentation over to this new generation
> method.
>
-- 
_
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-dev

Re: [asterisk-dev] issues-archive.asterisk.org is now available for preview

[George Joseph]

On Fri, Aug 4, 2023 at 11:38 AM  wrote:

> On 8/4/2023 9:48 AM, George Joseph wrote:
> > We've done a dump of all the ASTERISK-* issues and their attachments
> > from the issues.asterisk.org  Jira
> > instance and made them available at
> > https://issues-archive.asterisk.org. It'll be a few days before Google
> > gets around to indexing the entire site so the search bar isn't
> > working yet but you can browse the issues right now.  When the search
> > is fully working we'll announce it on the asterisk-users list as well.
> >
> > Take a look.
> Looks good on the surface to me. My main concern was patch attachments
> being preserved and it looks like they are.
>
> Just curious, how large is the export exactly? Certain things in JIRA
> were helpful like being able to filter issues by a keyword to "open",
> i.e. things which had and have not yet been resolved. The Google Search
> will help with indexing content but not with filtering,


Actually I may be able to customize the search results to be just a list.
If I have time next week, I'll take a look.


> I'd think. If
> it's not too large, do you think this would be better suited to allowing
> folks to download an archive and then be able to use tools like grep to
> find the issues they want?
>

235M uncompressed without attachments
41M in tarball
https://issues-archive.asterisk.org/asterisk-issue-archive.tar.gz

4.7G uncompressed attachments
They will not be made available as an archive.
If you want, you can simply munge the links to them in your local copy of
the html to point to the online versions.


>
> I don't know that the hosted archives needs to do this, I suspect very
> few people would have any need for being able to do that, and I don't
> want to add any work for anyone here.
>
> Side question, more on the legal side. When everything was on JIRA, I
> think the policy was that any patches on JIRA could be taken through
> code review by anyone else, so long as the uploader had signed the CLA.
> Now that it is on GitHub, and there is a new CLA, and most people have
> not resigned the CLA for patches from the past ~20 years, how does this
> affect patches in the JIRA archive? Since the CLA was valid when they
> were provided to the project, can they still be taken through code
> review by anyone else? What is the status of such patches? Thanks.
>

I'll have to let Josh answer that one.
-- 
_
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-dev

Re: [asterisk-dev] Final Preview: docs.asterisk.org

[asterisk]

On 8/4/2023 9:42 AM, George Joseph wrote:
Well, I've made a few more changes and pushed them up.  I think this 
is as good as it's going to get for now.


I think it's perfect. Down from 230 MB to 140 MB for the same build. 40% 
size reduction just by removing whitespace I guess! Looking at a few 
pages manually, the HTML looks perfect. No visible issues.


Only thing I noticed when building this time around was warnings like these:
INFO    -  Doc file 
'Asterisk_20_Documentation/API_Documentation/Dialplan_Functions/SMDI_MSG_RETRIEVE.md' 
contains an absolute link
'/Asterisk_20_Documentation/API_Documentation/Dialplan_Functions/SMDI_MSG', 
it was left as is. Did you mean 'SMDI_MSG.md'?
INFO    -  Doc file 
'Asterisk_20_Documentation/API_Documentation/Dialplan_Functions/STREAM_SILENCE.md' 
contains an absolute link
'/Asterisk_20_Documentation/API_Documentation/Dialplan_Applications/ChanSpy', 
it was left as is. Did you mean

   '../Dialplan_Applications/ChanSpy.md'?

However I tested the site and things seem to work fine. The build did 
take longer, possibly due to the above checks, 90 seconds vs 18, but 
that's not really an issue. The links do appear to be relative to me - 
I'm not putting this in a domain root, but in a subfolder, and the links 
all seem to work correctly for me. So I don't think there's an issue and 
it seems like this can be ignored - perhaps it went ahead and converted 
it on the fly. Just wanted to point that out in case I'm wrong.


Everything seems to work well, I don't see any further issues with 
anything here. Thanks a lot George for looking into these issues, I'm 
looking forward to porting documentation over to this new generation method.


--
_
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
  http://lists.digium.com/mailman/listinfo/asterisk-dev

Re: [asterisk-dev] issues-archive.asterisk.org is now available for preview

[asterisk]

On 8/4/2023 9:48 AM, George Joseph wrote:
We've done a dump of all the ASTERISK-* issues and their attachments 
from the issues.asterisk.org  Jira 
instance and made them available at 
https://issues-archive.asterisk.org. It'll be a few days before Google 
gets around to indexing the entire site so the search bar isn't 
working yet but you can browse the issues right now.  When the search 
is fully working we'll announce it on the asterisk-users list as well.


Take a look.
Looks good on the surface to me. My main concern was patch attachments 
being preserved and it looks like they are.


Just curious, how large is the export exactly? Certain things in JIRA 
were helpful like being able to filter issues by a keyword to "open", 
i.e. things which had and have not yet been resolved. The Google Search 
will help with indexing content but not with filtering, I'd think. If 
it's not too large, do you think this would be better suited to allowing 
folks to download an archive and then be able to use tools like grep to 
find the issues they want?


I don't know that the hosted archives needs to do this, I suspect very 
few people would have any need for being able to do that, and I don't 
want to add any work for anyone here.


Side question, more on the legal side. When everything was on JIRA, I 
think the policy was that any patches on JIRA could be taken through 
code review by anyone else, so long as the uploader had signed the CLA. 
Now that it is on GitHub, and there is a new CLA, and most people have 
not resigned the CLA for patches from the past ~20 years, how does this 
affect patches in the JIRA archive? Since the CLA was valid when they 
were provided to the project, can they still be taken through code 
review by anyone else? What is the status of such patches? Thanks.


--
_
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
  http://lists.digium.com/mailman/listinfo/asterisk-dev

Re: [asterisk-dev] Important!: Personal spaces on wiki.asterisk.org

[George Joseph]

On Fri, Aug 4, 2023 at 10:44 AM Fred Posner  wrote:

> Has there been a post on what is replacing this?
>

Nothing is replacing the personal spaces unless you create something
yourself.

Documentation is now hosted at https://docs.asterisk.org




>
>
> Regards,
>
> Fred Posner
>
>
>
> > On Aug 4, 2023, at 12:41 PM, George Joseph  wrote:
> >
> > When wiki.asterisk.org goes away (soon), any personal spaces you may
> have created will also be going away.  If you want the content, either grab
> it yourself or email me directly and I'll export it for you and send you a
> link to a tarball.  Either way, you should do this before next Friday
> August 11th.
> >
> > --
> > George Joseph
> > Asterisk Software Developer
> > Sangoma Technologies
> > Check us out at www.sangoma.com and www.asterisk.org
> > --
> > _
> > -- Bandwidth and Colocation Provided by http://www.api-digital.com --
> >
> > asterisk-dev mailing list
> > To UNSUBSCRIBE or update options visit:
> >   http://lists.digium.com/mailman/listinfo/asterisk-dev
>
>
>
> --
> _
> -- Bandwidth and Colocation Provided by http://www.api-digital.com --
>
> asterisk-dev mailing list
> To UNSUBSCRIBE or update options visit:
>http://lists.digium.com/mailman/listinfo/asterisk-dev
-- 
_
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-dev

Re: [asterisk-dev] Important!: Personal spaces on wiki.asterisk.org

[Fred Posner]

Has there been a post on what is replacing this?


Regards,

Fred Posner



> On Aug 4, 2023, at 12:41 PM, George Joseph  wrote:
> 
> When wiki.asterisk.org goes away (soon), any personal spaces you may have 
> created will also be going away.  If you want the content, either grab it 
> yourself or email me directly and I'll export it for you and send you a link 
> to a tarball.  Either way, you should do this before next Friday August 11th.
> 
> --
> George Joseph
> Asterisk Software Developer
> Sangoma Technologies
> Check us out at www.sangoma.com and www.asterisk.org
> -- 
> _
> -- Bandwidth and Colocation Provided by http://www.api-digital.com --
> 
> asterisk-dev mailing list
> To UNSUBSCRIBE or update options visit:
>   http://lists.digium.com/mailman/listinfo/asterisk-dev



-- 
_
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-dev

[asterisk-dev] Important!: Personal spaces on wiki.asterisk.org

[George Joseph]

When wiki.asterisk.org goes away (soon), any personal spaces you may have
created will also be going away.  If you want the content, either grab it
yourself or email me directly and I'll export it for you and send you a
link to a tarball.  Either way, you should do this before next Friday
August 11th.

--
George Joseph
Asterisk Software Developer
Sangoma Technologies
Check us out at www.sangoma.com and www.asterisk.org
-- 
_
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-dev

[asterisk-dev] issues-archive.asterisk.org is now available for preview

[George Joseph]

We've done a dump of all the ASTERISK-* issues and their attachments from
the issues.asterisk.org Jira instance and made them available at
https://issues-archive.asterisk.org.  It'll be a few days before Google
gets around to indexing the entire site so the search bar isn't working yet
but you can browse the issues right now.  When the search is fully working
we'll announce it on the asterisk-users list as well.

Take a look.


-- 
George Joseph
Asterisk Software Developer
Sangoma Technologies
Check us out at www.sangoma.com and www.asterisk.org
-- 
_
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-dev

Re: [asterisk-dev] Final Preview: docs.asterisk.org

[George Joseph]

Well, I've made a few more changes and pushed them up.  I think this is as
good as it's going to get for now.

On Fri, Jul 28, 2023 at 6:56 PM  wrote:

> On 7/28/2023 8:48 PM, George Joseph wrote:
> > On Fri, Jul 28, 2023 at 1:52 PM  > > wrote:
> >
> >
> > It's at the very bottom of the README:
> > > If you're always going to build just 1 branch's dynamic
> > documentation,
> > > you can skip the Makefile..inc file and just place everything in
> > the
> > > main Makefile.inc:
> >
> > The first Makefile..inc has an extra period world's least
> > important
> > typo.
> >
> >
> > Ahha!   It's 'Makefile..inc' in the source README.md but the
> > '' is getting stripped. :)
>
> Ah, probably should've noticed that, actually, Makefile.inc twice in a
> row doesn't make any sense, if I was actually thinking about it...
>
> > Circling back to one other thing now that this seems good to go, what
> > exactly did you change for reducing the file sizes / is that
> > included in
> > the current iteration, without mike?
> >
> >
> > The addition of "navigation.prune" under features in mkdocs.yml did
> > most of it, and yes, it's currently included.
> >
> > I'm still seeing a lot of
> > extraneous whitespace in the pages. 244 KB per page isn't huge,
> > but just
> > at a cursory glance,
> >
> >
> > Can you give me an example of an html page that's that big?  Most I
> > see are in the 80-100k range
>
> I think all of them - for example:
>
> https://docs.asterisk.org/Asterisk_20_Documentation/API_Documentation/Dialplan_Applications/ADSIProg/
>
> This one is "only" 131 KB, but if you go and view source, you can scroll
> down a bit and see often hundreds of newlines, tabs, and spaces at a
> time in a row. I can't work how that's creeping in from the markdown, so
> I don't think it's from the markdown. That's why I thought we might need
> to do it manually, e.g. using tr or something like that. So regardless
> of page size, I think we could likely prune all the pages down just by
> eliminating whitespace.
>
> >
> > I think we could probably cut the size 10-20% just
> > by getting rid of the whitespace. In some places, there are just
> > hundreds of newlines in a row for no reason.
> >
> >
> > Give me an example page.
> >
> > If this is just what the
> > tool generates, I understand that, we don't have any control over
> > that,
> > just wanted to know. We could remove it all pretty easily with sed
> > probably, and think could be a final "post processing" step in the
> > Makefile, run recursively on all files. What do you think?
> >
> >
> > I tried to do exactly that but it didn't result in much savings and I
> > got nervous about accidentally deleting multiple "blank" lines without
> > knowing whether you might be in a "" block or not.   I was going
> > to try html-minifier but just haven't got to it yet.
>
> Yeah, I guess that could be tricky. But how much is the  tag
> actually used? On the page linked above, for example, I only see it
> once, and, ironically, there isn't any extraneous whitespace in it.  I
> took a look at a few different types of pages and this appears to be the
> case for all of them. So in our particular case, it seems like it might
> be okay to do a simple delete, since  shouldn't be affected by
> consecutive whitespace.
>
-- 
_
-- Bandwidth and Colocation Provided by http://www.api-digital.com --

asterisk-dev mailing list
To UNSUBSCRIBE or update options visit:
   http://lists.digium.com/mailman/listinfo/asterisk-dev