@atlassian/clientside-extensions-docs
Advanced tools
Comparing version 2.3.0-docs-1 to 2.3.0-docs-2
@@ -7,3 +7,3 @@ --- | ||
subcategory: get-help | ||
date: '2021-07-19' | ||
date: '2021-07-21' | ||
--- | ||
@@ -37,2 +37,2 @@ | ||
- Check the [Debugging and troubleshooting an extension guide](/server/framework/clientside-extensions/guides/how-to/debugging-and-troubleshooting-an-extension/debugging-and-troubleshooting-an-extension) | ||
- Check the [Debugging and troubleshooting an extension guide](/server/framework/clientside-extensions/guides/how-to/debugging-and-troubleshooting-an-extension) |
@@ -7,3 +7,3 @@ --- | ||
subcategory: extension-points | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: extension-points | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: extension-points | ||
date: '2021-06-29' | ||
date: '2021-07-21' | ||
--- | ||
@@ -14,3 +14,4 @@ | ||
{{% warning %}} | ||
The APIs for creating extension points are based on the React framework and Atlaskit, meaning you can only use them if you're developing with React. | ||
The APIs for creating extension points are based on the React framework and Atlaskit, meaning you can | ||
only use them if you're developing with React. | ||
@@ -22,5 +23,7 @@ A framework agnostic solution is being designed and will be available on a future release. | ||
The Bitbucket Server team provides a template to create a Bitbucket Plugin with all the tools already configured for you, including Client-side Extensions (CSE). | ||
The Bitbucket Server team provides a template to create a Bitbucket Plugin with all the tools already configured for | ||
you, including Client-side Extensions (CSE). | ||
You can grab a copy by cloning the [Bitbucket CSE template](https://bitbucket.org/atlassianlabs/bitbucket-client-side-extensions-template): | ||
You can grab a copy by cloning | ||
the [Bitbucket CSE template](https://bitbucket.org/atlassianlabs/bitbucket-client-side-extensions-template): | ||
@@ -33,3 +36,4 @@ ``` | ||
If you want to create extension points on your own project, follow the guide on | ||
[how to setup CSE schema-loader](/server/framework/clientside-extensions/guides/how-to/setup-schema-loader/) before you get started. | ||
[how to setup CSE schema-loader](/server/framework/clientside-extensions/guides/how-to/setup-schema-loader/) before you | ||
get started. | ||
{{% /note %}} | ||
@@ -60,5 +64,21 @@ | ||
Once the Bitbucket starts, you should see this message in the terminal: | ||
``` | ||
bitbucket started successfully in XYZs at http://localhost:7990/bitbucket | ||
``` | ||
Now, you can open the browser and navigate to http://localhost:7990/bitbucket | ||
### Default credentials | ||
The local instance of Bitbucket requires you to log in using those credentials: | ||
- username: `admin` | ||
- password: `admin` | ||
## Developing | ||
The template comes with watchmode and hot reload configured for your front-end code. You can run the CSE watch server by executing: | ||
The template comes with watchmode and hot reload configured for your front-end code. You can run the CSE watch server by | ||
executing: | ||
@@ -71,8 +91,10 @@ ``` | ||
You will be working on a blank page created with [CSE page extensions](/server/framework/clientside-extensions/reference/api/extension-factories/page/), | ||
and will create an extension point named `extension.points.tutorial`. | ||
You will be working on a blank page created | ||
with [CSE page extensions](/server/framework/clientside-extensions/reference/api/extension-factories/page/), and will | ||
create an extension point named `extension.points.tutorial`. | ||
{{% note %}} | ||
It is not necessary to use [CSE page extensions](/server/framework/clientside-extensions/reference/api/extension-factories/page/) to create an extension point. This guide uses them | ||
to provide a clean environment for working with extension point APIs. | ||
It is not necessary to | ||
use [CSE page extensions](/server/framework/clientside-extensions/reference/api/extension-factories/page/) to create an | ||
extension point. This guide uses them to provide a clean environment for working with extension point APIs. | ||
{{% /note %}} | ||
@@ -86,7 +108,8 @@ | ||
- `./extension-points-page.jsx`: the blank page where you are going to create your extension point and render the extensions | ||
- `./extension-points-page.jsx`: the blank page where you are going to create your extension point and render the | ||
extensions | ||
- `./extensions/`: a set of extensions that you're going fetch and render throughout the guides. | ||
Once you install and start Bitbucket Server from the template, you can head to the tutorial page | ||
and should see the title `extension.points.tutorial` | ||
Once you install and start Bitbucket Server from the template, you can head to the tutorial page and should see the | ||
title `extension.points.tutorial` | ||
@@ -97,2 +120,3 @@ - http://localhost:7990/bitbucket/plugins/servlet/extension-points | ||
You're now ready to [create your first extension point](/server/framework/clientside-extensions/guides/extension-points/creating-an-extension-point/)! | ||
You're now ready | ||
to [create your first extension point](/server/framework/clientside-extensions/guides/extension-points/creating-an-extension-point/)! |
@@ -7,3 +7,3 @@ --- | ||
subcategory: extension-points | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: extension-points | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: how-to | ||
date: '2021-06-29' | ||
date: '2021-07-21' | ||
--- | ||
@@ -36,9 +36,10 @@ | ||
1. First, you need to start the application, open the web browser, and navigate to the administration panel. | ||
2. Next, find and navigate to the **Manage Apps** page. | ||
3. On the list of all installed plugins, locate your plugin using **App key** (**plugin key**), and check whether all the plugin's modules are enabled: | ||
1. First, you need to start the application, open the web browser, and navigate to the administration panel of your application. | ||
1. If you are using a local instance of Bitbucket or [Bitbucket CSE Template](https://bitbucket.org/atlassianlabs/bitbucket-client-side-extensions-template) project to develop the plugin, then use `admin` as the user and `admin` as the password to log in into the administration panel. | ||
1. Next, find and navigate to the **Manage Apps** page. | ||
1. On the list of all installed plugins, locate your plugin using **App key** (**plugin key**), and check whether all the plugin's modules are enabled: | ||
 | ||
4. If your plugin is on the list and all the modules are enabled, you can proceed to the next step. | ||
1. If your plugin is on the list and all the modules are enabled, you can proceed to the next step. | ||
@@ -45,0 +46,0 @@ {{% tip %}} |
@@ -7,3 +7,3 @@ --- | ||
subcategory: how-to | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: how-to | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: how-to | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2021-06-29' | ||
date: '2021-07-21' | ||
--- | ||
@@ -53,5 +53,20 @@ | ||
Once the Bitbucket starts, you should see this message in the terminal: | ||
``` | ||
bitbucket started successfully in XYZs at http://localhost:7990/bitbucket | ||
``` | ||
Now, you can open the browser and navigate to http://localhost:7990/bitbucket | ||
### Default credentials | ||
The local instance of Bitbucket requires you to log in using those credentials: | ||
- username: `admin` | ||
- password: `admin` | ||
## Developing | ||
The template comes with watchmode and hot reload configured for your front-end code. You can run the CSE watch server executing: | ||
The template comes with watchmode and hot reload configured for your front-end code. You can run the CSE watch server by executing: | ||
@@ -58,0 +73,0 @@ ``` |
@@ -7,3 +7,3 @@ --- | ||
subcategory: introduction | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: index | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: api | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: glossary | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: webpack | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
@@ -7,3 +7,3 @@ --- | ||
subcategory: webpack | ||
date: '2021-06-29' | ||
date: '2021-07-19' | ||
--- | ||
@@ -10,0 +10,0 @@ |
{ | ||
"name": "@atlassian/clientside-extensions-docs", | ||
"version": "2.3.0-docs-1", | ||
"version": "2.3.0-docs-2", | ||
"description": "Holds the official documentation for Altassian Server client-side extensions API.", | ||
@@ -5,0 +5,0 @@ "license": "BSD-3-Clause", |
2391204