New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@atlassian/clientside-extensions-docs

Package Overview
Dependencies
Maintainers
8
Versions
167
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@atlassian/clientside-extensions-docs - npm Package Compare versions

Comparing version 2.3.1-beta-2 to 2.3.1-docs-1

28

content/server/framework/clientside-extensions/get-help.md

@@ -7,3 +7,3 @@ ---

subcategory: get-help
date: '2021-06-24'
date: '2021-07-21'
---

@@ -13,2 +13,26 @@

If you need help or want to give any feedback, please refer to our [Issue Tracker](https://bitbucket.org/atlassian/atlassian-clientside-extensions/issues).
## Client-Side Extensions
If you need help or want to give any feedback about CSE, please refer to our [Issue Tracker](https://ecosystem.atlassian.net/browse/CSE).
Click on the "Create" issue button and provide the reproduction steps. Please include as much information as you can, including:
- Application name and version
- A version of CSE modules you are using
- Browser vendor name and version
## Support
### If you are a Marketplace Developer
If you are a Marketplace Developer, you can [contact support team and request help](https://developer.atlassian.com/platform/marketplace/#marketplace-support).
### If you are not a Marketplace Developer
If you are not a Marketplace Developer but have a Server or DC product license go to [https://support.atlassian.com](https://support.atlassian.com).
At the bottom of the page, there should be a green “Contact Support” button you can use
## Additional links
- Check the [Debugging and troubleshooting an extension guide](/server/framework/clientside-extensions/guides/how-to/debugging-and-troubleshooting-an-extension)

2

content/server/framework/clientside-extensions/guides/extension-points/creating-an-extension-point.md

@@ -7,3 +7,3 @@ ---

subcategory: extension-points
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/guides/extension-points/extension-point-documentation.md

@@ -7,3 +7,3 @@ ---

subcategory: extension-points
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

52

content/server/framework/clientside-extensions/guides/extension-points/index.md

@@ -7,3 +7,3 @@ ---

subcategory: extension-points
date: '2021-06-24'
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/)!

2

content/server/framework/clientside-extensions/guides/extension-points/providing-context.md

@@ -7,3 +7,3 @@ ---

subcategory: extension-points
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/guides/extension-points/rendering-extensions.md

@@ -7,3 +7,3 @@ ---

subcategory: extension-points
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

11

content/server/framework/clientside-extensions/guides/how-to/debugging-and-troubleshooting-an-extension.md

@@ -7,3 +7,3 @@ ---

subcategory: how-to
date: '2021-06-24'
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:
![Manage Apps](/server/framework/clientside-extensions/guides/how-to/debugging-and-troubleshooting-an-extension/plugin-troubleshooting.png)
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 %}}

2

content/server/framework/clientside-extensions/guides/how-to/setup-page-bootstrapper.md

@@ -7,3 +7,3 @@ ---

subcategory: how-to
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/guides/how-to/setup-schema-loader.md

@@ -7,3 +7,3 @@ ---

subcategory: how-to
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/guides/how-to/setup-webpack-plugin.md

@@ -7,3 +7,3 @@ ---

subcategory: how-to
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/guides/introduction/creating-a-modal.md

@@ -7,3 +7,3 @@ ---

subcategory: introduction
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/guides/introduction/creating-a-page.md

@@ -7,3 +7,3 @@ ---

subcategory: introduction
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/guides/introduction/creating-an-extension.md

@@ -7,3 +7,3 @@ ---

subcategory: introduction
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/guides/introduction/custom-HTML-content.md

@@ -7,3 +7,3 @@ ---

subcategory: introduction
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/guides/introduction/discovering-extension-points.md

@@ -7,3 +7,3 @@ ---

subcategory: introduction
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

19

content/server/framework/clientside-extensions/guides/introduction/index.md

@@ -7,3 +7,3 @@ ---

subcategory: introduction
date: '2021-06-24'
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 @@ ```

2

content/server/framework/clientside-extensions/guides/introduction/using-extension-api.md

@@ -7,3 +7,3 @@ ---

subcategory: introduction
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/index.md

@@ -7,3 +7,3 @@ ---

subcategory: index
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-api/async-panel-api.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-api/index.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-api/modal-api.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-api/panel-api.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-api/render-element-as-react.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-factories/async-panel.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-factories/button.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-factories/index.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-factories/link.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-factories/modal.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-factories/page.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-factories/panel.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

8

content/server/framework/clientside-extensions/reference/api/extension-points-v1-deprecated.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -22,3 +22,3 @@

First, make sure to install and provide Client-side Extensions in your Product as described in the [Installation Guide](https://bitbucket.org/atlassian/atlassian-clientside-extensions/src/master/INSTALLATION.md).
First, make sure to install and provide Client-side Extensions in your Product as described in the [Installation Guide for v1](https://bitbucket.org/atlassian/atlassian-clientside-extensions/src/v1.2.9/INSTALLATION.md).

@@ -315,6 +315,6 @@ Next, add `@atlassian/clientside-extensions-components` to your project.

Handlers continue to work the same on the recent version of CSE. Refer to the [extension handlers](/server/framework/clientside-extensions/reference/api/extension-handlers/) guide to learn how to use them.
Handlers continue to work the same on the recent version of CSE. Refer to the [extension handlers](/server/framework/clientside-extensions/reference/api/extension-points/extension-handlers/) guide to learn how to use them.
{{% warning %}}
Refer to the [extension handlers](/server/framework/clientside-extensions/reference/api/extension-handlers/) guide.
Refer to the [extension handlers](/server/framework/clientside-extensions/reference/api/extension-points/extension-handlers/) guide.
{{% /warning %}}

2

content/server/framework/clientside-extensions/reference/api/extension-points/extension-handlers.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/api/extension-points/hooks-and-components.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

4

content/server/framework/clientside-extensions/reference/api/extension-points/index.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -86,3 +86,3 @@

{{% tip %}}
Follow the [How to setup CSE schema-loader](/server/framework/clientside-extensions/reference/guides/how-to/setup-schema-loader)
Follow the [How to setup CSE schema-loader](/server/framework/clientside-extensions/guides/how-to/setup-schema-loader)
to learn how to install and configure the loader.

@@ -89,0 +89,0 @@ {{% /tip %}}

2

content/server/framework/clientside-extensions/reference/api/extension-points/schemas.md

@@ -7,3 +7,3 @@ ---

subcategory: api
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/glossary/index.md

@@ -7,3 +7,3 @@ ---

subcategory: glossary
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/webpack-plugin/annotations.md

@@ -7,3 +7,3 @@ ---

subcategory: webpack
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

2

content/server/framework/clientside-extensions/reference/webpack-plugin/webpack-plugin.md

@@ -7,3 +7,3 @@ ---

subcategory: webpack
date: '2021-06-24'
date: '2022-04-20'
---

@@ -10,0 +10,0 @@

4

data/clientside-extensions.json

@@ -250,4 +250,8 @@ {

"to": "/reference/api/extension-api/render-element-as-react/"
},
{
"from": "/reference/api/extension-handlers/",
"to": "/reference/api/extension-points/extension-handlers/"
}
]
}

10

package.json
{
"name": "@atlassian/clientside-extensions-docs",
"version": "2.3.1-beta-2",
"version": "2.3.1-docs-1",
"description": "Holds the official documentation for Altassian Server client-side extensions API.",

@@ -66,5 +66,5 @@ "license": "BSD-3-Clause",

"scripts": {
"start": "npm run preview",
"start": "atlas dac watch",
"usage": "doc-scripts usage",
"preview": "doc-scripts preview",
"preview": "atlas dac watch",
"lint": "yarn spellcheck && yarn prettier",

@@ -81,5 +81,5 @@ "prettier": "prettier --check '**/*.{json,md}'",

"optionalDependencies": {
"@atlassian/doc-scripts": "^3.0.6"
"@atlassian/doc-scripts": "^5.0.1"
},
"gitHead": "d019c7af67bdee8c1bb3c6c53eab1e5f96d5471e"
"gitHead": "7b887b7b65cfd5bb8344a0894f6249cd97672692"
}

7

README.md

@@ -11,8 +11,5 @@ # Client-side Extensions Docs

`yarn preview`
1. Install [Atlas CLI](https://developer.atlassian.com/platform/atlas-cli/users/install/) and DAC plugin `atlas plugin install -n dac`.
2. Run `yarn start` to start the server with the content locally at : [http://localhost:8080/server/framework/clientside-extensions](http://localhost:8080/server/framework/clientside-extensions)
This will first install the Docker image needed to run the Atlassian Docs locally, and then start the server with the content locally at:
[http://localhost:8080/server/framework/clientside-extensions](http://localhost:8080/server/framework/clientside-extensions)
## Validation

@@ -19,0 +16,0 @@

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc