Migrate content from MediaWiki bot page on wiki to user manual

[ostephens]

New user manual has details about creating a bot for Wikidata https://docs.openrefine.org/manual/wikidata#manage-wikidata-account

There is a page on the wiki that gives more general information about creating a bot account for any Wikibase instance https://github.com/OpenRefine/OpenRefine/wiki/MediaWiki-Bot-Passwords

The more general information should be migrated across to the new user manual and then the MediaWiki-Bot-Passwords page in the wiki can be deprecated (replace the content with a link to the relevant page in the new user manual)

[AhwiniMirajkar]

I want to work on this

[MohamedMetwalli5]

Could I work on this issue?

[wetneb]

@MohamedMetwalli5 sure! @AhwiniMirajkar sorry for the lack of reaction on this…

[Shatakshi0805]

I would like to work on this issue.

[wetneb]

@Shatakshi0805 sure, thank you!

[Shatakshi0805]

Thank you for assigning. I needed a little help as I cloned the wiki repo on my machine I'm not able to find the Mediawiki Bot passwords page in the OpenRefine.wiki folder that I Cloned and I need it to edit and use its content. I am able to see other files But I am not able to locate the file which I need to edit and copy the content from. Could you please help me with the same?

[thadguidry]

@Shatakshi0805 you should see it now. Try to clone again. Looks like we had an error on an older FAQ page title that was causing a checkout issue, and I deleted that page FAQ: Allocate More Memory which was no longer needed and a duplicate. (colon char : is a reserved char for filenames on some OS's like Windows)

Let me know if it is now resolved and that you can see the file needed MediaWiki-Bot-Passwords.md when checking out our master branch for the wiki as I just did below to verify it works now.

[wetneb]

Otherwise you could simply copy the source of the page at https://github.com/OpenRefine/OpenRefine/wiki/MediaWiki-Bot-Passwords/_edit

[Shatakshi0805]

Yes, It works. I am now able to see the files by checking on the master branch and then cloning. Thank you so much @thadguidry and @wetneb for helping. Really appreciate it! :)

[Shatakshi0805]

I had one last question. Apologies for asking questions so many times as I am a beginner and facing these issues. [Q] After making changes in docs and saving them and running successfully on local host through yarn start I am not able to see the changes that I made on the website on local host server. Is it like this or I have missed some step in this process?

[thadguidry]

yarn should have opened your local browser for http://localhost:3000 by default and reflected the changes very quickly in seconds on the browser window that it popped up... without having to restart the server. See https://github.com/OpenRefine/OpenRefine/tree/master/docs#local-development

E:\GitHubRepos\OpenRefine>cd docs

E:\GitHubRepos\OpenRefine\docs>yarn
yarn install v1.22.10
[1/4] Resolving packages...
[2/4] Fetching packages...
info [email protected]: The platform "win32" is incompatible with this module.
info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
info [email protected]: The platform "win32" is incompatible with this module.
info "[email protected]" is an optional dependency and failed compatibility check. Excluding it from installation.
[3/4] Linking dependencies...
warning "@docusaurus/preset-classic > @docusaurus/theme-search-algolia > @docsearch/[email protected]" has unmet peer dependency "@types/react@>= 16.8.0 < 
18.0.0".
warning "@docusaurus/preset-classic > @docusaurus/theme-search-algolia > @docsearch/react > @algolia/[email protected]" has unmet peer dependency "@algolia/client-search@^4.5.1".
[4/4] Building fresh packages...
Done in 49.54s.

E:\GitHubRepos\OpenRefine\docs>yarn start
yarn run v1.22.10
$ docusaurus start
Starting the development server...
Docusaurus website is running at: http://localhost:3000/

√ Client
  Compiled successfully in 20.24s

i ｢wds｣: Project is running at http://localhost:3000/
i ｢wds｣: webpack output is served from /
i ｢wds｣: Content not from webpack is served from E:\GitHubRepos\OpenRefine\docs
i ｢wds｣: 404s will fallback to /index.html

Did you save the file?

Hmm, I'm also seeing the same thing now. This used to work just great a few months ago. Yarn is dynamically recompiling whenever I save the file with changes I made, as shown in terminal:

√ Client
  Compiled successfully in 814.43ms

Docusaurus website is running at: http://localhost:3000/

√ Client
  Compiled successfully in 825.63ms

Docusaurus website is running at: http://localhost:3000/

But I also don't see the changes reflected live or even after a refresh on my browser pointed to http://localhost:3000 So something is definitely wrong somewhere or needs deeper looking into...

[Shatakshi0805]

Yes, I saved the file and then ran on local server. And the only issue I am facing is not able to see the changes that I made on the website. Do let me know if there is something that I can help with.

[thadguidry]

@Shatakshi0805 You can help by finding out why it's doing that? Ask the docusaurus or yarn community? Because I also have the same problem now and have no idea and tried a few things for over an hour at that time.

[wetneb]

@Shatakshi0805 beware that we have versioning in place: perhaps you are editing the dev version of a page, but you are looking at the released version (3.4) of the page on the website?

You could also try making some random changes to docs/versioned_docs/version-3.4/index.md and check if you can see them at http://localhost:3000.

[thadguidry]

@wetneb Yeap, that works correctly now!

So it seems that the version "current" or as what @wetneb says "dev version" really means whats in the /docs/docs folder from what I read and not the versioned docs under versioned_docs\version-3.4

versions.json :

[
  "current"
]

For us that is current docs I.E. for 3.5 version...not older 3.4 version?

So to edit and see the docs for older 3.4 version, we just need to change to

versions.json :

[
  "3.4"
]

In a separate issue, I'm not sure about the docusaurus.config.js change what we might want to do for lastVersion: undefined for the doc plugin section itself

        /**
         * The last version is the one we navigate to in priority on versioned sites
         * It is the one displayed by default in docs navbar items
         * By default, the last version is the first one to appear in versions.json
         * By default, the last version is at the "root" (docs have path=/docs/myDoc)
         * Note: it is possible to configure the path and label of the last version
         * Tip: using lastVersion: 'current' make sense in many cases
         */
        lastVersion: undefined,

[thadguidry]

@Shatakshi0805 Checkout our master branch again and notice the updated README.md file under /docs/docs which should help you on this issue now. We were missing the new info about the "next" version of OpenRefine docs, which is whatever is under /docs/docs path and represented in the URL with /next. Take a look and let us know.

[Shatakshi0805]

Thank you Thad for guidance. I will try this now and will update.

[thadguidry]

@Shatakshi0805 No problem, and if I didn't explain it well enough in that README.md then feel free to submit a PR to improve that also!

[Shatakshi0805]

yes, it seems clear to me.

[khadijm]

hi @wetneb can i continue to work on this issues? thanks

[khadijm]

if possible please can you assign this issue to me thanks

[khadijm]

ready for review @ostephens and @wetneb https://github.com/OpenRefine/OpenRefine/pull/4652

[amyra98]

Is there anything left to work on this issue @thadguidry @wetneb

[wetneb]

I cannot see the contents of the wiki page in the official docs, so yes, this issue is still current.

[amyra98]

Please assign me this issue. @wetneb What content do I have to add and exactly where in the docs?

[wetneb]

I would say that figuring this out is part of the task :)

You could try to familiarize yourself with the structure of the documentation of our Wikibase integration. There is likely a place where logging in to Wikibase via OpenRefine is mentioned. It probably makes sense to insert the contents of this wiki page there. You will likely have to adapt the wording and formatting so that it fits nicely in the existing content.

[amyra98]

Okay I can do that. Please assign me the issue @wetneb