Migrating from perf.wiki.kernel.org to RTD

Migrating from perf.wiki.kernel.org to RTD

[Konstantin Ryabitsev]

Hello, all:

We are getting rid of all mediawikis and replacing them either with archived
sites, or RTD-style documentation. The perf wiki is one of the last ones to
migrate, and I would like to propose that it is migrated to RTD-style docs.
I've done the initial conversion from MediaWiki for your review:

# Initial conversion

I've done the initial conversion and the preliminary results can be viewed
here:

https://www.kernel.org/doc/projects/perf/

The underlying git repository is here:

https://git.kernel.org/pub/scm/docs/docsko/perf.git/

It actually contains most of the wiki history as well, excluding media.

# What happens next?

There are two ways forward:

1. You can clone that git repository and host it on github. This would allow
   for a quick readthedocs.org integration and allow you to edit the files
   directly via the github interface. This is a very wiki-like workflow and
   would allow you to grant access to the repository to anyone with a github
   account, plus accept pull requests with modifications. Once you have
   readthedocs.org integration working, we can configure it to be under the
   docs.kernel.org domain, which will allow you to remove the ads from the
   site.

2. Continue to host it in the current location and accept edits via members of
   kernel.org and patches sent to this mailing list.

Please let me know how you would like to proceed. If I don't hear back from
anyone in the next few days, I will configure the perf.docs.kernel.org with
the current converted contents and redirect perf.wiki.kernel.org there.

Best regards,
-K

Re: Migrating from perf.wiki.kernel.org to RTD

[Ian Rogers]

On Fri, Oct 11, 2024 at 1:24 PM Konstantin Ryabitsev
<konstantin@linuxfoundation.org> wrote:
>
> Hello, all:
>
> We are getting rid of all mediawikis and replacing them either with archived
> sites, or RTD-style documentation. The perf wiki is one of the last ones to
> migrate, and I would like to propose that it is migrated to RTD-style docs.
> I've done the initial conversion from MediaWiki for your review:
>
> # Initial conversion
>
> I've done the initial conversion and the preliminary results can be viewed
> here:
>
> https://www.kernel.org/doc/projects/perf/
>
> The underlying git repository is here:
>
> https://git.kernel.org/pub/scm/docs/docsko/perf.git/
>
> It actually contains most of the wiki history as well, excluding media.
>
> # What happens next?
>
> There are two ways forward:
>
> 1. You can clone that git repository and host it on github. This would allow
>    for a quick readthedocs.org integration and allow you to edit the files
>    directly via the github interface. This is a very wiki-like workflow and
>    would allow you to grant access to the repository to anyone with a github
>    account, plus accept pull requests with modifications. Once you have
>    readthedocs.org integration working, we can configure it to be under the
>    docs.kernel.org domain, which will allow you to remove the ads from the
>    site.
>
> 2. Continue to host it in the current location and accept edits via members of
>    kernel.org and patches sent to this mailing list.
>
> Please let me know how you would like to proceed. If I don't hear back from
> anyone in the next few days, I will configure the perf.docs.kernel.org with
> the current converted contents and redirect perf.wiki.kernel.org there.

Hi Konstantin,

Yunseong created:
https://perfwiki.github.io/main/
which looks superior to:
https://git.kernel.org/pub/scm/docs/docsko/perf.git/
as it is using markdown. Compare:
https://git.kernel.org/pub/scm/docs/docsko/perf.git/tree/source/top_down_analysis.rst
with:
https://github.com/perfwiki/main/blob/main/docs/top-down-analysis.md
Perhaps the solution here is to make perf.wiki.kernel.org a redirect
to https://perfwiki.github.io/main/

Thanks,
Ian

Re: Migrating from perf.wiki.kernel.org to RTD

[Konstantin Ryabitsev]

On Fri, Oct 11, 2024 at 02:37:24PM GMT, Ian Rogers wrote:
> Hi Konstantin,
> 
> Yunseong created:
> https://perfwiki.github.io/main/

Oh, I wasn't aware of this effort. Would have saved me a good few hours. :)

> which looks superior to:
> https://git.kernel.org/pub/scm/docs/docsko/perf.git/
> as it is using markdown. Compare:
> https://git.kernel.org/pub/scm/docs/docsko/perf.git/tree/source/top_down_analysis.rst
> with:
> https://github.com/perfwiki/main/blob/main/docs/top-down-analysis.md

Well, this is just the github renderer. Github will happily render rst files
as well as markdown files. The reason I chose rst is because:

1. it's a better defined standard than markdown, which has as many flavours as
   there are forges, pretty much
2. the kernel already uses rst, so it's an easier switch for most kernel devs

> Perhaps the solution here is to make perf.wiki.kernel.org a redirect
> to https://perfwiki.github.io/main/

I'm happy to go either way, I just need the wiki to be gone. If this decision
is final, let me know and I will set the redirects.

-K

Re: Migrating from perf.wiki.kernel.org to RTD

[Konstantin Ryabitsev]

On Fri, Oct 11, 2024 at 06:39:09PM -0400, Konstantin Ryabitsev wrote:
> > Yunseong created:
> > https://perfwiki.github.io/main/
> > Perhaps the solution here is to make perf.wiki.kernel.org a redirect
> > to https://perfwiki.github.io/main/

To speed things along, and since the old perf wiki was near-unusable anyway,
I went ahead and set the redirects from perf.wiki.kernel.org to
perfwiki.github.io.

Please feel free to follow up if we need to revisit this, but things look good
to me with this change.

Thank you!

-K

Re: Migrating from perf.wiki.kernel.org to RTD

[Namhyung Kim]

Hello Konstantin,

On Tue, Oct 15, 2024 at 02:25:02PM -0400, Konstantin Ryabitsev wrote:
> On Fri, Oct 11, 2024 at 06:39:09PM -0400, Konstantin Ryabitsev wrote:
> > > Yunseong created:
> > > https://perfwiki.github.io/main/
> > > Perhaps the solution here is to make perf.wiki.kernel.org a redirect
> > > to https://perfwiki.github.io/main/
> 
> To speed things along, and since the old perf wiki was near-unusable anyway,
> I went ahead and set the redirects from perf.wiki.kernel.org to
> perfwiki.github.io.
> 
> Please feel free to follow up if we need to revisit this, but things look good
> to me with this change.

Thanks for your work, it looks good to me too.

Namhyung

Re: Migrating from perf.wiki.kernel.org to RTD

[Ian Rogers]

On Tue, Oct 15, 2024 at 6:51 PM Namhyung Kim <namhyung@kernel.org> wrote:
>
> Hello Konstantin,
>
> On Tue, Oct 15, 2024 at 02:25:02PM -0400, Konstantin Ryabitsev wrote:
> > On Fri, Oct 11, 2024 at 06:39:09PM -0400, Konstantin Ryabitsev wrote:
> > > > Yunseong created:
> > > > https://perfwiki.github.io/main/
> > > > Perhaps the solution here is to make perf.wiki.kernel.org a redirect
> > > > to https://perfwiki.github.io/main/
> >
> > To speed things along, and since the old perf wiki was near-unusable anyway,
> > I went ahead and set the redirects from perf.wiki.kernel.org to
> > perfwiki.github.io.
> >
> > Please feel free to follow up if we need to revisit this, but things look good
> > to me with this change.
>
> Thanks for your work, it looks good to me too.

Thanks Konstantin and Yunseong, I think it looks good!
I think the pages need some improving, there are empty pages and
things that look abandoned, such as the white paper linked from the
side bar:
https://perfwiki.github.io/main/white-paper/
I pushed a few improvements to the glossary and useful links. It
should be as easy as creating a pull request for others to contribute,
so I look forward to this.

Thanks,
Ian

Re: Migrating from perf.wiki.kernel.org to RTD

[Yunseong Kim]

Hi 

I would like to express my sincere gratitude to everyone for their help in the
official renewal of the perf wiki.

Additionally, the reason I chose to use Markdown is that I wanted to actively
utilize its media features. For example, I wanted to embed videos,
presentation slide or display Mermaid diagrams directly on the page.
I thought these features would be welcomed by users who are new to perf tools.

On 10/19/24 8:47 오전, Ian Rogers wrote:
> On Tue, Oct 15, 2024 at 6:51 PM Namhyung Kim <namhyung@kernel.org> wrote:
>>
>> Hello Konstantin,
>>
>> On Tue, Oct 15, 2024 at 02:25:02PM -0400, Konstantin Ryabitsev wrote:
>>> On Fri, Oct 11, 2024 at 06:39:09PM -0400, Konstantin Ryabitsev wrote:
>>>>> Yunseong created:
>>>>> https://perfwiki.github.io/main/
>>>>> Perhaps the solution here is to make perf.wiki.kernel.org a redirect
>>>>> to https://perfwiki.github.io/main/
>>>
>>> To speed things along, and since the old perf wiki was near-unusable anyway,
>>> I went ahead and set the redirects from perf.wiki.kernel.org to
>>> perfwiki.github.io.
>>>
>>> Please feel free to follow up if we need to revisit this, but things look good
>>> to me with this change.
>>
>> Thanks for your work, it looks good to me too.

I have been continuously improving the content of the documentation, so please
feel free to share any good ideas you may have. :)

> Thanks Konstantin and Yunseong, I think it looks good!
> I think the pages need some improving, there are empty pages and
> things that look abandoned, such as the white paper linked from the
> side bar:
> https://perfwiki.github.io/main/white-paper/
> I pushed a few improvements to the glossary and useful links. It
> should be as easy as creating a pull request for others to contribute,
> so I look forward to this.

Thank you so much Ian, I added per-page editing features to make it more convenient
for people to edit the documentation and submit pull requests.
Link: https://github.com/perfwiki/main/commit/4289b6a6e5c2e53d69a7605d01d0773366a33c52

> Thanks,
> Ian

Best regards,
Yunseong Kim

Re: Migrating from perf.wiki.kernel.org to RTD

[Adrian Hunter]

On 20/10/24 07:49, Yunseong Kim wrote:
> I would like to express my sincere gratitude to everyone for their help in the
> official renewal of the perf wiki.
> 
> Additionally, the reason I chose to use Markdown is that I wanted to actively
> utilize its media features. For example, I wanted to embed videos,
> presentation slide or display Mermaid diagrams directly on the page.
> I thought these features would be welcomed by users who are new to perf tools.
> 
> On 10/19/24 8:47 오전, Ian Rogers wrote:
>> On Tue, Oct 15, 2024 at 6:51 PM Namhyung Kim <namhyung@kernel.org> wrote:
>>> On Tue, Oct 15, 2024 at 02:25:02PM -0400, Konstantin Ryabitsev wrote:
>>>> On Fri, Oct 11, 2024 at 06:39:09PM -0400, Konstantin Ryabitsev wrote:
>>>>>> Yunseong created:
>>>>>> https://perfwiki.github.io/main/
>>>>>> Perhaps the solution here is to make perf.wiki.kernel.org a redirect
>>>>>> to https://perfwiki.github.io/main/
>>>>
>>>> To speed things along, and since the old perf wiki was near-unusable anyway,
>>>> I went ahead and set the redirects from perf.wiki.kernel.org to
>>>> perfwiki.github.io.

Links to old pages end up at the main page.  For example:

https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
https://perf.wiki.kernel.org/index.php/Top-Down_Analysis

Any way to get them to redirect to the correct page?

>>>>
>>>> Please feel free to follow up if we need to revisit this, but things look good
>>>> to me with this change.

Do we still have the old pages?  I would like to check that the Intel PT
page is not missing anything or munged.

>>>
>>> Thanks for your work, it looks good to me too.
> 
> I have been continuously improving the content of the documentation, so please
> feel free to share any good ideas you may have. :)
> 
>> Thanks Konstantin and Yunseong, I think it looks good!
>> I think the pages need some improving, there are empty pages and
>> things that look abandoned, such as the white paper linked from the
>> side bar:
>> https://perfwiki.github.io/main/white-paper/
>> I pushed a few improvements to the glossary and useful links. It
>> should be as easy as creating a pull request for others to contribute,
>> so I look forward to this.
> 
> Thank you so much Ian, I added per-page editing features to make it more convenient
> for people to edit the documentation and submit pull requests.
> Link: https://github.com/perfwiki/main/commit/4289b6a6e5c2e53d69a7605d01d0773366a33c52

I do not understand.  Is it a wiki anymore?  If so, what is
needed to edit a page?

Also how can page updates be submitted programmatically?
I had a script auto-updating the latest man pages, using
MediaWiki API, which I will have to redo :-(

Re: Migrating from perf.wiki.kernel.org to RTD

[Yunseong Kim]

Hi Adrian,

On 10/24/24 2:34 오전, Adrian Hunter wrote:
> On 20/10/24 07:49, Yunseong Kim wrote:
>> I would like to express my sincere gratitude to everyone for their help in the
>> official renewal of the perf wiki.
>>
>> Additionally, the reason I chose to use Markdown is that I wanted to actively
>> utilize its media features. For example, I wanted to embed videos,
>> presentation slide or display Mermaid diagrams directly on the page.
>> I thought these features would be welcomed by users who are new to perf tools.
>>
>> On 10/19/24 8:47 오전, Ian Rogers wrote:
>>> On Tue, Oct 15, 2024 at 6:51 PM Namhyung Kim <namhyung@kernel.org> wrote:
>>>> On Tue, Oct 15, 2024 at 02:25:02PM -0400, Konstantin Ryabitsev wrote:
>>>>> On Fri, Oct 11, 2024 at 06:39:09PM -0400, Konstantin Ryabitsev wrote:
>>>>>>> Yunseong created:
>>>>>>> https://perfwiki.github.io/main/
>>>>>>> Perhaps the solution here is to make perf.wiki.kernel.org a redirect
>>>>>>> to https://perfwiki.github.io/main/
>>>>>
>>>>> To speed things along, and since the old perf wiki was near-unusable anyway,
>>>>> I went ahead and set the redirects from perf.wiki.kernel.org to
>>>>> perfwiki.github.io.
> 
> Links to old pages end up at the main page.  For example:
> 
> https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
> https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
> 
> Any way to get them to redirect to the correct page?

We can use web.archive.org as of September 30th of last month.

Intel PT Link:
https://web.archive.org/web/20240930185823/https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace

Top-Down_Analysis Link:
https://web.archive.org/web/20240930164757/https://perf.wiki.kernel.org/index.php/Top-Down_Analysis


>>>>> Please feel free to follow up if we need to revisit this, but things look good
>>>>> to me with this change.
> 
> Do we still have the old pages?  I would like to check that the Intel PT
> page is not missing anything or munged.
> 
>>>>
>>>> Thanks for your work, it looks good to me too.
>>
>> I have been continuously improving the content of the documentation, so please
>> feel free to share any good ideas you may have. :)
>>
>>> Thanks Konstantin and Yunseong, I think it looks good!
>>> I think the pages need some improving, there are empty pages and
>>> things that look abandoned, such as the white paper linked from the
>>> side bar:
>>> https://perfwiki.github.io/main/white-paper/
>>> I pushed a few improvements to the glossary and useful links. It
>>> should be as easy as creating a pull request for others to contribute,
>>> so I look forward to this.
>>
>> Thank you so much Ian, I added per-page editing features to make it more convenient
>> for people to edit the documentation and submit pull requests.
>> Link: https://github.com/perfwiki/main/commit/4289b6a6e5c2e53d69a7605d01d0773366a33c52
> 
> I do not understand.  Is it a wiki anymore?  If so, what is
> needed to edit a page?

If you need to update the page directly, I can grant you permission to
do so. This is similar to the previous login system based on Media Wiki.

The issue with the old wiki was that logging in was broken(sadly) for
several months.

> Also how can page updates be submitted programmatically?

You can submit a Pull Request or if you have the necessary permissions,
you can directly update the document to add changes to the main branch.

> I had a script auto-updating the latest man pages, using
> MediaWiki API, which I will have to redo :-(

Could you let me know what script auto-updating you were performing with
the URL of the API or the specific functionality? If there is anything
else you need, please feel free to let me know. I will do my best to
assist you.

Best regards,
Yunseong Kim

Re: Migrating from perf.wiki.kernel.org to RTD

[Namhyung Kim]

On Thu, Oct 24, 2024 at 03:17:38AM +0900, Yunseong Kim wrote:
> Hi Adrian,
> 
> On 10/24/24 2:34 오전, Adrian Hunter wrote:
> > On 20/10/24 07:49, Yunseong Kim wrote:
> >> I would like to express my sincere gratitude to everyone for their help in the
> >> official renewal of the perf wiki.
> >>
> >> Additionally, the reason I chose to use Markdown is that I wanted to actively
> >> utilize its media features. For example, I wanted to embed videos,
> >> presentation slide or display Mermaid diagrams directly on the page.
> >> I thought these features would be welcomed by users who are new to perf tools.
> >>
> >> On 10/19/24 8:47 오전, Ian Rogers wrote:
> >>> On Tue, Oct 15, 2024 at 6:51 PM Namhyung Kim <namhyung@kernel.org> wrote:
> >>>> On Tue, Oct 15, 2024 at 02:25:02PM -0400, Konstantin Ryabitsev wrote:
> >>>>> On Fri, Oct 11, 2024 at 06:39:09PM -0400, Konstantin Ryabitsev wrote:
> >>>>>>> Yunseong created:
> >>>>>>> https://perfwiki.github.io/main/
> >>>>>>> Perhaps the solution here is to make perf.wiki.kernel.org a redirect
> >>>>>>> to https://perfwiki.github.io/main/
> >>>>>
> >>>>> To speed things along, and since the old perf wiki was near-unusable anyway,
> >>>>> I went ahead and set the redirects from perf.wiki.kernel.org to
> >>>>> perfwiki.github.io.
> > 
> > Links to old pages end up at the main page.  For example:
> > 
> > https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
> > https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
> > 
> > Any way to get them to redirect to the correct page?
> 
> We can use web.archive.org as of September 30th of last month.
> 
> Intel PT Link:
> https://web.archive.org/web/20240930185823/https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
> 
> Top-Down_Analysis Link:
> https://web.archive.org/web/20240930164757/https://perf.wiki.kernel.org/index.php/Top-Down_Analysis

The corresponding pages in the new site are:

 https://perfwiki.github.io/main/perf-tools-support-for-intel-processor-trace/

 https://perfwiki.github.io/main/top-down-analysis/

Thanks,
Namhyung

> 
> 
> >>>>> Please feel free to follow up if we need to revisit this, but things look good
> >>>>> to me with this change.
> > 
> > Do we still have the old pages?  I would like to check that the Intel PT
> > page is not missing anything or munged.
> > 
> >>>>
> >>>> Thanks for your work, it looks good to me too.
> >>
> >> I have been continuously improving the content of the documentation, so please
> >> feel free to share any good ideas you may have. :)
> >>
> >>> Thanks Konstantin and Yunseong, I think it looks good!
> >>> I think the pages need some improving, there are empty pages and
> >>> things that look abandoned, such as the white paper linked from the
> >>> side bar:
> >>> https://perfwiki.github.io/main/white-paper/
> >>> I pushed a few improvements to the glossary and useful links. It
> >>> should be as easy as creating a pull request for others to contribute,
> >>> so I look forward to this.
> >>
> >> Thank you so much Ian, I added per-page editing features to make it more convenient
> >> for people to edit the documentation and submit pull requests.
> >> Link: https://github.com/perfwiki/main/commit/4289b6a6e5c2e53d69a7605d01d0773366a33c52
> > 
> > I do not understand.  Is it a wiki anymore?  If so, what is
> > needed to edit a page?
> 
> If you need to update the page directly, I can grant you permission to
> do so. This is similar to the previous login system based on Media Wiki.
> 
> The issue with the old wiki was that logging in was broken(sadly) for
> several months.
> 
> > Also how can page updates be submitted programmatically?
> 
> You can submit a Pull Request or if you have the necessary permissions,
> you can directly update the document to add changes to the main branch.
> 
> > I had a script auto-updating the latest man pages, using
> > MediaWiki API, which I will have to redo :-(
> 
> Could you let me know what script auto-updating you were performing with
> the URL of the API or the specific functionality? If there is anything
> else you need, please feel free to let me know. I will do my best to
> assist you.
> 
> Best regards,
> Yunseong Kim

Re: Migrating from perf.wiki.kernel.org to RTD

[Arnaldo Carvalho de Melo]

On Wed, Oct 23, 2024 at 02:54:40PM -0700, Namhyung Kim wrote:
> On Thu, Oct 24, 2024 at 03:17:38AM +0900, Yunseong Kim wrote:
> > On 10/24/24 2:34 오전, Adrian Hunter wrote:
> > > On 20/10/24 07:49, Yunseong Kim wrote:
> > >> I would like to express my sincere gratitude to everyone for their help in the
> > >> official renewal of the perf wiki.

> > >> Additionally, the reason I chose to use Markdown is that I wanted to actively
> > >> utilize its media features. For example, I wanted to embed videos,
> > >> presentation slide or display Mermaid diagrams directly on the page.
> > >> I thought these features would be welcomed by users who are new to perf tools.

> > >> On 10/19/24 8:47 오전, Ian Rogers wrote:
> > >>> On Tue, Oct 15, 2024 at 6:51 PM Namhyung Kim <namhyung@kernel.org> wrote:
> > >>>> On Tue, Oct 15, 2024 at 02:25:02PM -0400, Konstantin Ryabitsev wrote:
> > >>>>> On Fri, Oct 11, 2024 at 06:39:09PM -0400, Konstantin Ryabitsev wrote:
> > >>>>>>> Yunseong created:
> > >>>>>>> https://perfwiki.github.io/main/
> > >>>>>>> Perhaps the solution here is to make perf.wiki.kernel.org a redirect
> > >>>>>>> to https://perfwiki.github.io/main/

> > >>>>> To speed things along, and since the old perf wiki was near-unusable anyway,
> > >>>>> I went ahead and set the redirects from perf.wiki.kernel.org to
> > >>>>> perfwiki.github.io.

> > > Links to old pages end up at the main page.  For example:

> > > https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
> > > https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
 
> > > Any way to get them to redirect to the correct page?

> > We can use web.archive.org as of September 30th of last month.

> > Intel PT Link:
> > https://web.archive.org/web/20240930185823/https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace

> > Top-Down_Analysis Link:
> > https://web.archive.org/web/20240930164757/https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
 
> The corresponding pages in the new site are:
 
>  https://perfwiki.github.io/main/perf-tools-support-for-intel-processor-trace/
 
>  https://perfwiki.github.io/main/top-down-analysis/

It is unfortunate that we can't have some sort of mapping from the old
URLs to the new ones, I can imagine other sites having links that now
will get broken :-\

- Arnaldo

Re: Migrating from perf.wiki.kernel.org to RTD

[Ian Rogers]

On Wed, Oct 23, 2024 at 3:33 PM Arnaldo Carvalho de Melo
<acme@kernel.org> wrote:
>
> On Wed, Oct 23, 2024 at 02:54:40PM -0700, Namhyung Kim wrote:
> > On Thu, Oct 24, 2024 at 03:17:38AM +0900, Yunseong Kim wrote:
> > > On 10/24/24 2:34 오전, Adrian Hunter wrote:
> > > > On 20/10/24 07:49, Yunseong Kim wrote:
> > > >> I would like to express my sincere gratitude to everyone for their help in the
> > > >> official renewal of the perf wiki.
>
> > > >> Additionally, the reason I chose to use Markdown is that I wanted to actively
> > > >> utilize its media features. For example, I wanted to embed videos,
> > > >> presentation slide or display Mermaid diagrams directly on the page.
> > > >> I thought these features would be welcomed by users who are new to perf tools.
>
> > > >> On 10/19/24 8:47 오전, Ian Rogers wrote:
> > > >>> On Tue, Oct 15, 2024 at 6:51 PM Namhyung Kim <namhyung@kernel.org> wrote:
> > > >>>> On Tue, Oct 15, 2024 at 02:25:02PM -0400, Konstantin Ryabitsev wrote:
> > > >>>>> On Fri, Oct 11, 2024 at 06:39:09PM -0400, Konstantin Ryabitsev wrote:
> > > >>>>>>> Yunseong created:
> > > >>>>>>> https://perfwiki.github.io/main/
> > > >>>>>>> Perhaps the solution here is to make perf.wiki.kernel.org a redirect
> > > >>>>>>> to https://perfwiki.github.io/main/
>
> > > >>>>> To speed things along, and since the old perf wiki was near-unusable anyway,
> > > >>>>> I went ahead and set the redirects from perf.wiki.kernel.org to
> > > >>>>> perfwiki.github.io.
>
> > > > Links to old pages end up at the main page.  For example:
>
> > > > https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
> > > > https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
>
> > > > Any way to get them to redirect to the correct page?
>
> > > We can use web.archive.org as of September 30th of last month.
>
> > > Intel PT Link:
> > > https://web.archive.org/web/20240930185823/https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
>
> > > Top-Down_Analysis Link:
> > > https://web.archive.org/web/20240930164757/https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
>
> > The corresponding pages in the new site are:
>
> >  https://perfwiki.github.io/main/perf-tools-support-for-intel-processor-trace/
>
> >  https://perfwiki.github.io/main/top-down-analysis/
>
> It is unfortunate that we can't have some sort of mapping from the old
> URLs to the new ones, I can imagine other sites having links that now
> will get broken :-\

Are there particular pages you think will get broken? When I follow
old links I get the "main" page and it has links to the intel PT and
other pages on the left. Perhaps 1 more mouse click is necessary, and
we need to make sure it is easy to get to the popular old pages from
the main page. I agree it isn't ideal but I'm not sure we can do
better. It isn't totally broken, which the old wiki login system had
become - so this is an improvement for me as I can at least edit
pages.

Thanks,
Ian

Re: Migrating from perf.wiki.kernel.org to RTD

[Adrian Hunter]

On 24/10/24 01:33, Arnaldo Carvalho de Melo wrote:
> On Wed, Oct 23, 2024 at 02:54:40PM -0700, Namhyung Kim wrote:
>> On Thu, Oct 24, 2024 at 03:17:38AM +0900, Yunseong Kim wrote:
>>> On 10/24/24 2:34 오전, Adrian Hunter wrote:
>>>> On 20/10/24 07:49, Yunseong Kim wrote:
>>>>> I would like to express my sincere gratitude to everyone for their help in the
>>>>> official renewal of the perf wiki.
> 
>>>>> Additionally, the reason I chose to use Markdown is that I wanted to actively
>>>>> utilize its media features. For example, I wanted to embed videos,
>>>>> presentation slide or display Mermaid diagrams directly on the page.
>>>>> I thought these features would be welcomed by users who are new to perf tools.
> 
>>>>> On 10/19/24 8:47 오전, Ian Rogers wrote:
>>>>>> On Tue, Oct 15, 2024 at 6:51 PM Namhyung Kim <namhyung@kernel.org> wrote:
>>>>>>> On Tue, Oct 15, 2024 at 02:25:02PM -0400, Konstantin Ryabitsev wrote:
>>>>>>>> On Fri, Oct 11, 2024 at 06:39:09PM -0400, Konstantin Ryabitsev wrote:
>>>>>>>>>> Yunseong created:
>>>>>>>>>> https://perfwiki.github.io/main/
>>>>>>>>>> Perhaps the solution here is to make perf.wiki.kernel.org a redirect
>>>>>>>>>> to https://perfwiki.github.io/main/
> 
>>>>>>>> To speed things along, and since the old perf wiki was near-unusable anyway,
>>>>>>>> I went ahead and set the redirects from perf.wiki.kernel.org to
>>>>>>>> perfwiki.github.io.
> 
>>>> Links to old pages end up at the main page.  For example:
> 
>>>> https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
>>>> https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
>  
>>>> Any way to get them to redirect to the correct page?
> 
>>> We can use web.archive.org as of September 30th of last month.

I would prefer the source.  Does anyone have that?

> 
>>> Intel PT Link:
>>> https://web.archive.org/web/20240930185823/https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
> 
>>> Top-Down_Analysis Link:
>>> https://web.archive.org/web/20240930164757/https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
>  
>> The corresponding pages in the new site are:
>  
>>  https://perfwiki.github.io/main/perf-tools-support-for-intel-processor-trace/
>  
>>  https://perfwiki.github.io/main/top-down-analysis/
> 
> It is unfortunate that we can't have some sort of mapping from the old
> URLs to the new ones, I can imagine other sites having links that now
> will get broken :-\

Why do we need mappings?  Just use the same page names and have the
redirect keep the final part of the url.

By the way, the new "wiki" doesn't seem to render "page not found"
properly for non-existent pages:

	https://perfwiki.github.io/main/not-a-page

Re: Migrating from perf.wiki.kernel.org to RTD

[Yunseong Kim]

Hi Adrian,

On 10/24/24 2:58 오후, Adrian Hunter wrote:
> I would prefer the source.  Does anyone have that?

Looking through the archives, I found a source version that predates
September 30th.
Link:
https://web.archive.org/web/20240526075334/https://perf.wiki.kernel.org/index.php?title=Perf_tools_support_for_Intel%C2%AE_Processor_Trace&action=edit

The Markdown version is available here:
https://github.com/perfwiki/main/blob/main/docs/perf-tools-support-for-intel-processor-trace.md

You can edit it directly:
https://github.com/perfwiki/main/edit/main/docs/perf-tools-support-for-intel-processor-trace.md

Once finalized, it will be visible here:
https://perfwiki.github.io/main/perf-tools-support-for-intel-processor-trace/

>>>> Intel PT Link:
>>>> https://web.archive.org/web/20240930185823/https://
>>>> perf.wiki.kernel.org/index.php/
>>>> Perf_tools_support_for_Intel%C2%AE_Processor_Trace
>>>> Top-Down_Analysis Link:
>>>> https://web.archive.org/web/20240930164757/https://
>>>> perf.wiki.kernel.org/index.php/Top-Down_Analysis
>>
>>> The corresponding pages in the new site are:
>>
>>>  https://perfwiki.github.io/main/perf-tools-support-for-intel-
>>> processor-trace/
>>
>>>  https://perfwiki.github.io/main/top-down-analysis/
>> It is unfortunate that we can't have some sort of mapping from the old
>> URLs to the new ones, I can imagine other sites having links that now
>> will get broken 😕
> Why do we need mappings?  Just use the same page names and have the
> redirect keep the final part of the url.

If possible, I'll try to set up a redirection. Thank you for suggesting
this good idea.

> By the way, the new "wiki" doesn't seem to render "page not found"
> properly for non-existent pages:
>
> 	https://perfwiki.github.io/main/not-a-page

I'll work on fixing this as soon as possible. I see that it's showing a
404 page but the webpage style is broken.

On 10/24/24 3:07 오후, Adrian Hunter wrote:
> On 23/10/24 21:17, Yunseong Kim wrote:
>> Hi Adrian,
>>
>> Intel PT Link:
>>
https://web.archive.org/web/20240930185823/https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
>>
>> Top-Down_Analysis Link:
>>
https://web.archive.org/web/20240930164757/https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
>>>
>>> Do we still have the old pages?  I would like to check that the Intel PT
>>> page is not missing anything or munged.
>>> I do not understand.  Is it a wiki anymore?  If so, what is
>>> needed to edit a page?
>>
>> If you need to update the page directly, I can grant you permission to
>> do so. This is similar to the previous login system based on Media Wiki.
>
> Yes please.

Are you using the GitHub account from that link?
https://github.com/ahunter6

I've sent an writer access request so you can work directly on the
documentation in the repository.

> I updated the latest manual pages last month.
>
> It is disappointing you did not contact people still updating the
> old wiki.

I apologize Adrian, You're right. I missed the part you worked hard on.
This was due to my inexperience. I will do better moving forward. I'll
double check against the web archive from September 30th to make sure I
haven't missed anything.

It may take some time for me to complete the work, but I'll do my best
to make it as quickly as possible. Thank you Adrian for providing
valuable feedback from the perspective of users who have been using the
wiki page.

Warm regards,
Yunseong Kim

Re: Migrating from perf.wiki.kernel.org to RTD

[Adrian Hunter]

On 27/10/24 19:08, Yunseong Kim wrote:
> Hi Adrian,
> 
> On 10/24/24 2:58 오후, Adrian Hunter wrote:
>> I would prefer the source.  Does anyone have that?
> 
> Looking through the archives, I found a source version that predates
> September 30th.
> Link:
> https://web.archive.org/web/20240526075334/https://perf.wiki.kernel.org/index.php?title=Perf_tools_support_for_Intel%C2%AE_Processor_Trace&action=edit
> 
> The Markdown version is available here:
> https://github.com/perfwiki/main/blob/main/docs/perf-tools-support-for-intel-processor-trace.md
> 
> You can edit it directly:
> https://github.com/perfwiki/main/edit/main/docs/perf-tools-support-for-intel-processor-trace.md
> 
> Once finalized, it will be visible here:
> https://perfwiki.github.io/main/perf-tools-support-for-intel-processor-trace/
> 
>>>>> Intel PT Link:
>>>>> https://web.archive.org/web/20240930185823/https://
>>>>> perf.wiki.kernel.org/index.php/
>>>>> Perf_tools_support_for_Intel%C2%AE_Processor_Trace
>>>>> Top-Down_Analysis Link:
>>>>> https://web.archive.org/web/20240930164757/https://
>>>>> perf.wiki.kernel.org/index.php/Top-Down_Analysis
>>>
>>>> The corresponding pages in the new site are:
>>>
>>>>  https://perfwiki.github.io/main/perf-tools-support-for-intel-
>>>> processor-trace/
>>>
>>>>  https://perfwiki.github.io/main/top-down-analysis/
>>> It is unfortunate that we can't have some sort of mapping from the old
>>> URLs to the new ones, I can imagine other sites having links that now
>>> will get broken 😕
>> Why do we need mappings?  Just use the same page names and have the
>> redirect keep the final part of the url.
> 
> If possible, I'll try to set up a redirection. Thank you for suggesting
> this good idea.
> 
>> By the way, the new "wiki" doesn't seem to render "page not found"
>> properly for non-existent pages:
>>
>> 	https://perfwiki.github.io/main/not-a-page
> 
> I'll work on fixing this as soon as possible. I see that it's showing a
> 404 page but the webpage style is broken.
> 
> On 10/24/24 3:07 오후, Adrian Hunter wrote:
>> On 23/10/24 21:17, Yunseong Kim wrote:
>>> Hi Adrian,
>>>
>>> Intel PT Link:
>>>
> https://web.archive.org/web/20240930185823/https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
>>>
>>> Top-Down_Analysis Link:
>>>
> https://web.archive.org/web/20240930164757/https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
>>>>
>>>> Do we still have the old pages?  I would like to check that the Intel PT
>>>> page is not missing anything or munged.
>>>> I do not understand.  Is it a wiki anymore?  If so, what is
>>>> needed to edit a page?
>>>
>>> If you need to update the page directly, I can grant you permission to
>>> do so. This is similar to the previous login system based on Media Wiki.
>>
>> Yes please.
> 
> Are you using the GitHub account from that link?
> https://github.com/ahunter6
> 
> I've sent an writer access request so you can work directly on the
> documentation in the repository.

Thank you! You have been very helpful :-)

Re: Migrating from perf.wiki.kernel.org to RTD

[Konstantin Ryabitsev]

On Mon, Oct 28, 2024 at 02:08:45AM +0900, Yunseong Kim wrote:
> Hi Adrian,
> 
> On 10/24/24 2:58 오후, Adrian Hunter wrote:
> > I would prefer the source.  Does anyone have that?
> 
> Looking through the archives, I found a source version that predates
> September 30th.

If it helps, I've uploaded the latest export I took before the shutdown here:
https://github.com/mricon/perfwiki

It should have full history of the wiki edits (in theory).

-K

Re: Migrating from perf.wiki.kernel.org to RTD

[Yunseong Kim]

Hi Konstantin,

On 10/29/24 1:22 오전, Konstantin Ryabitsev wrote:
> On Mon, Oct 28, 2024 at 02:08:45AM +0900, Yunseong Kim wrote:
>> Hi Adrian,
>>
>> On 10/24/24 2:58 오후, Adrian Hunter wrote:
>>> I would prefer the source.  Does anyone have that?
>>
>> Looking through the archives, I found a source version that predates
>> September 30th.
> 
> If it helps, I've uploaded the latest export I took before the shutdown here:
> https://github.com/mricon/perfwiki
> 
> It should have full history of the wiki edits (in theory).
> 
> -K

Thanks so much for the sharing. This will be really helpful when I
review the documents!

Best regards,
Yunseong Kim

Re: Migrating from perf.wiki.kernel.org to RTD

[Adrian Hunter]

On 23/10/24 21:17, Yunseong Kim wrote:
> Hi Adrian,
> 
> On 10/24/24 2:34 오전, Adrian Hunter wrote:
>> On 20/10/24 07:49, Yunseong Kim wrote:
>>> I would like to express my sincere gratitude to everyone for their help in the
>>> official renewal of the perf wiki.
>>>
>>> Additionally, the reason I chose to use Markdown is that I wanted to actively
>>> utilize its media features. For example, I wanted to embed videos,
>>> presentation slide or display Mermaid diagrams directly on the page.
>>> I thought these features would be welcomed by users who are new to perf tools.
>>>
>>> On 10/19/24 8:47 오전, Ian Rogers wrote:
>>>> On Tue, Oct 15, 2024 at 6:51 PM Namhyung Kim <namhyung@kernel.org> wrote:
>>>>> On Tue, Oct 15, 2024 at 02:25:02PM -0400, Konstantin Ryabitsev wrote:
>>>>>> On Fri, Oct 11, 2024 at 06:39:09PM -0400, Konstantin Ryabitsev wrote:
>>>>>>>> Yunseong created:
>>>>>>>> https://perfwiki.github.io/main/
>>>>>>>> Perhaps the solution here is to make perf.wiki.kernel.org a redirect
>>>>>>>> to https://perfwiki.github.io/main/
>>>>>>
>>>>>> To speed things along, and since the old perf wiki was near-unusable anyway,
>>>>>> I went ahead and set the redirects from perf.wiki.kernel.org to
>>>>>> perfwiki.github.io.
>>
>> Links to old pages end up at the main page.  For example:
>>
>> https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
>> https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
>>
>> Any way to get them to redirect to the correct page?
> 
> We can use web.archive.org as of September 30th of last month.
> 
> Intel PT Link:
> https://web.archive.org/web/20240930185823/https://perf.wiki.kernel.org/index.php/Perf_tools_support_for_Intel%C2%AE_Processor_Trace
> 
> Top-Down_Analysis Link:
> https://web.archive.org/web/20240930164757/https://perf.wiki.kernel.org/index.php/Top-Down_Analysis
> 
> 
>>>>>> Please feel free to follow up if we need to revisit this, but things look good
>>>>>> to me with this change.
>>
>> Do we still have the old pages?  I would like to check that the Intel PT
>> page is not missing anything or munged.
>>
>>>>>
>>>>> Thanks for your work, it looks good to me too.
>>>
>>> I have been continuously improving the content of the documentation, so please
>>> feel free to share any good ideas you may have. :)
>>>
>>>> Thanks Konstantin and Yunseong, I think it looks good!
>>>> I think the pages need some improving, there are empty pages and
>>>> things that look abandoned, such as the white paper linked from the
>>>> side bar:
>>>> https://perfwiki.github.io/main/white-paper/
>>>> I pushed a few improvements to the glossary and useful links. It
>>>> should be as easy as creating a pull request for others to contribute,
>>>> so I look forward to this.
>>>
>>> Thank you so much Ian, I added per-page editing features to make it more convenient
>>> for people to edit the documentation and submit pull requests.
>>> Link: https://github.com/perfwiki/main/commit/4289b6a6e5c2e53d69a7605d01d0773366a33c52
>>
>> I do not understand.  Is it a wiki anymore?  If so, what is
>> needed to edit a page?
> 
> If you need to update the page directly, I can grant you permission to
> do so. This is similar to the previous login system based on Media Wiki.

Yes please.

> 
> The issue with the old wiki was that logging in was broken(sadly) for
> several months.

I updated the latest manual pages last month.

It is disappointing you did not contact people still updating the
old wiki.

> 
>> Also how can page updates be submitted programmatically?
> 
> You can submit a Pull Request or if you have the necessary permissions,
> you can directly update the document to add changes to the main branch.
> 
>> I had a script auto-updating the latest man pages, using
>> MediaWiki API, which I will have to redo :-(
> 
> Could you let me know what script auto-updating you were performing with
> the URL of the API or the specific functionality? If there is anything
> else you need, please feel free to let me know. I will do my best to
> assist you.
> 
> Best regards,
> Yunseong Kim