Help:Getting Started: Difference between revisions

From Wikitech
Content deleted Content added
Dvorapa (talk | contribs)
m typo
Remove content duplicated elsewhere and make this page mostly navigational
 
(18 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Mbox|image=[[File:Ambox PR.svg|40x40px|link=|alt=]]|text=Please read the [[Help:Cloud_Services_Introduction|Wikimedia Cloud Services Introduction]].}}

{{TOC|align=right}}

==Overview==

[[Help:Cloud_Services_Introduction|Wikimedia Cloud Services]] provides tools, services, and support for technical collaborators who want to contribute to Wikimedia software projects.

This page outlines the accounts you will need and basic first steps, which will allow you to contribute to this wiki and Wikimedia's technical spaces, including:

* [[Portal:Toolforge|Toolforge]]
* [[toollabs:openstack-browser/project/|Cloud VPS Projects]]
* [[w:Gerrit_(software)| Gerrit]]

'''You will learn how to:'''

* Join an existing project or begin a new project.
* Add members or admins to projects.
* Create and configure instances within a project.
* Find help and ways to participate.


== Set up your accounts ==
== Set up your accounts ==


{{Account_setup}}
To access and contribute to Cloud Services projects and tools, you will need the following accounts. Please note, these are two distinct accounts:

*'''Wikimedia account''' - this account is used to contribute to Wikipedia and its sister projects.
** When you create your Wikimedia account, you will create a username and password.
*[[Help:Create_a_Wikimedia_developer_account|'''Wikimedia developer account''']] - this account is used to log into this wiki, Toolforge, Cloud VPS, Gerrit and other protected Wikimedia Services.
** When you create your Wikimedia developer account, you will create a username (sometimes called LDAP username), UNIX shell username, and password.


== Get started with Toolforge ==
== Get started with Toolforge ==


Follow the steps on [[Help:Toolforge/Quickstart]].
# Submit a [https://toolsadmin.wikimedia.org/tools/membership/apply Toolforge project membership request].
# Wait for membership approval.
#* Your request will be reviewed, and you will receive confirmation within a week. You will be notified through your Wikitech user account that you have been added to the project [[Nova Resource:Tools]].
#* ''Once you are added as a Toolforge member you must logout and then login again at https://toolsadmin.wikimedia.org/ for your membership to take effect.''
# Access the Toolforge project.
#* Use your "UNIX shell username" provided when creating your developer account and the SSH private key matching the public key you supplied for authentication.

For more information about accessing the project, please see
[[Help:Toolforge#Using_Toolforge_and_managing_your_files|Using Toolforge and managing your files]].

{{notice | It can take up to 5 minutes from account creation time until your user is in the proper groups }}


== Get started with Cloud VPS Projects ==
== Get started with Cloud VPS Projects ==


Follow the steps on [[Portal:Cloud VPS]].
=== Join an existing project ===

# Choose a project to join with [[toollabs:openstack-browser/|OpenStack browser]].
# Request membership by [[phab: maniphest/task/edit/form/1/ | creating a Phabricator task]] and assigning it directly to the project administrator(s).
#*You can find the list of project admins by going to <kbd><nowiki>http://tools.wmflabs.org/openstack-browser/project/<project-name></nowiki></kbd>.

=== Create a new project ===

# Follow the instructions on the [[phab:project/view/2875/|"Cloud-VPS (Project-requests)" phabricator task]].

=== Add members and admin users to a project ===

Project admins can use the following steps to add new members or grant administrative permissions to members.

# Go to [[Special:NovaProject]].
# Use '''Add member''' link to add new members.
# Use '''Add member''' link for the '''projectadmin''' role in the '''Role''' column.
#* Log at {{irc|wikimedia-cloud}} that you added/granted admin to the member.

=== Learn about project instances ===

To learn more about project instances, read the [[Help:Instances|project instances documentation]].

=== Log your actions ===

It is best practice to log changes to all instances of your project.

Wikimedia Cloud Services provides a [[Server Admin Log]] for users to log their project server administration actions on.

You can add a log entry in the {{irc|wikimedia-cloud}} channel on [[:en:Freenode|Freenode]] by using the sending a message like: <code>!log <projectname> <message></code>

See [[Tool:Stashbot]] for more information.


== Get started with Gerrit ==
== Get started with Gerrit ==
Line 82: Line 16:
Gerrit is Wikimedia's code review system.
Gerrit is Wikimedia's code review system.


Once you have created your Wikimedia account and Wikimedia developer account, including your UNIX shell username, follow the instructions in the [https://www.mediawiki.org/wiki/Gerrit/Tutorial#Set_Up_SSH_Keys_in_Gerrit Gerrit tutorial] to get started.
Once you have [[Help:Create_a_Wikimedia_developer_account|created your Wikimedia account and Wikimedia developer account]], including your UNIX shell username, follow the instructions in the [https://www.mediawiki.org/wiki/Gerrit/Tutorial#Set_Up_SSH_Keys_in_Gerrit Gerrit tutorial] to get started.


{{:Help:Cloud Services communication}}
{{:Help:Cloud Services communication}}

== See also ==

* [[Help:At_a_glance:_Cloud_VPS_and_Toolforge|At-a-Glance: Cloud VPS and Toolforge]]



[[Category:Cloud Services]]
[[Category:Cloud Services]]

Latest revision as of 20:14, 22 September 2023

Set up your accounts

To access Toolforge, Cloud VPS, or other Wikimedia developer tools, you need the following two types of accounts:

Account Type Description Where to sign up
Wikimedia account Also known as "Wikimedia single user login (SUL)" account. Allows you to log into general wikis like Wikipedia, MediaWiki, and MetaWiki. Create Wikimedia account
Wikimedia developer account Username (also called LDAP username) is used to log in on Wikitech (this wiki), Gerrit, and the Toolforge admin console. In GitLab it is your displayed name, so you may want it to be your full name. You will not be able to change this later!

Shell username is used to log into Toolforge, other Wikimedia VPS or Wikimedia production hosts using SSH.

Create Wikimedia developer account

Get started with Toolforge

Follow the steps on Help:Toolforge/Quickstart.

Get started with Cloud VPS Projects

Follow the steps on Portal:Cloud VPS.

Get started with Gerrit

Gerrit is Wikimedia's code review system.

Once you have created your Wikimedia account and Wikimedia developer account, including your UNIX shell username, follow the instructions in the Gerrit tutorial to get started.

Communication and support

Support and administration of the WMCS resources is provided by the Wikimedia Foundation Cloud Services team and Wikimedia movement volunteers. Please reach out with questions and join the conversation:

Discuss and receive general support
Stay aware of critical changes and plans
Track work tasks and report bugs

Use a subproject of the #Cloud-Services Phabricator project to track confirmed bug reports and feature requests about the Cloud Services infrastructure itself

Read stories and WMCS blog posts

Read the Cloud Services Blog (for the broader Wikimedia movement, see the Wikimedia Technical Blog)