Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature add annotate excel guide #526

Merged

Conversation

Etschbeijer
Copy link
Contributor

Thank you for contributing to the DataPLANT Knowledge Base 🚀

Please make sure that

  • your pull request has a good title,
  • you add a short description below to summarize your changes,
  • the contents and images you add, are allowed to be shared publicly and - if applicable - reference the source properly,
  • you read the contribution guide,
  • you tested your changes locally via npm run dev and npm run build

If you are unsure, you can also label your PR as draft.

Description

Add documentation for swate excel
Updated several existing swate pages

Copy link
Collaborator

@Freymaurer Freymaurer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor changes then good-to-go

src/content/docs/guides/annotate-in-excel.mdx Outdated Show resolved Hide resolved
import { Steps } from '@astrojs/starlight/components';
import { Tabs, TabItem } from '@astrojs/starlight/components';

<Tabs syncKey="host">
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rename syncKey to more descriptive "swateHost"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed


![Image showing add new file option in Swate](@images/swate/swate-excel-add-annotation-table.png)

## Top level metadata handling
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make this a new file

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Add installation guide for excel in browser
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make this image WAY smaller. So much dead space

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

The excel-add-in will soon be published in the official [Microsoft Excel-Add-Ins Store](https://appsource.microsoft.com/en-us/marketplace/apps?product=excel).
The excel-add-in will soon be published in the official [Microsoft Excel-Add-Ins Store](https://appsource.microsoft.com/en-us/marketplace/apps?product=excel).
Currently, we recommend the installation using the [excel-browser version provided by microsoft](https://excel.cloud.microsoft/?wdOrigin=MARKETING.FREE.GO-TO-EXCEL) because the set up is much easier than with a local excel version.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add "installation" header here and remove headers in tabs.

Indent images to the right so they can be included in steps and do not restart the steps component after each image. Use one steps component and indent the content to fit it into the steps component

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed


5. Then you select choose the folder where you have downloaded the [Manifest File](https://github.com/nfdi4plants/Swate/tree/main/src/Client/public) to and select it, in order to upload it.
6. When the installation was successful, the icon of [Swate](https://nfdi4plants.github.io/nfdi4plants.knowledgebase/swate/), the Excel-Add-In for annotating data, should be available in the data tab.
7. When you click on the icon the sidebar of swate should appear. Its size is adaptable and when it is big enough, the quick icons of the navbar are visible.
8. When everything was successful, it should look similar to this:

</Steps>

</TabItem>
<TabItem label="Excel">

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add "installation" header here and remove headers in tabs.

Did not remove headers in tabs

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These will be visible in the sidebar, even when they are hidden by selecting a different tab

@Freymaurer Freymaurer merged commit ff2aea3 into nfdi4plants:main Nov 15, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants