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

[Yunseong Kim <yskelg@gmail.com>]

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