atsign-foundation/atsign.dev

This repo is no longer in use -> Navigate to docs.atsign.com to view most up-to-date code.

atsign.dev

The atsign.dev repo is home to the code behind our developer site. As everything we have to offer is open-source, why not make our website open-source too, to prove that we aren't using cookies or anything that tracks your presence.

Why is there an atsign.dev?

We hope that this site has the A -> Z of everything you will need to develop with the atPlatform.

If you are a developer, this is your site - come join us and help us improve the content and the experience. We are always learning from you.

What can you find in atsign.dev?

If you are new to the atPlatform, learn about how the platform works and how this can make such a big difference for you by cutting down on time to develop and market applications.

The site gives you all the tools, samples, examples and documentation needed to get started on the atPlatform and SDK. The site also provides access to the various communities where you can collaborate and talk to other developers working on the platform.

Pages we recommend visiting:

If this is your first time here, we strongly recommend navigating through our ‘getting started’ page. There, you will find all of the steps you will need to take in order to start developing your very own atPlatform application.

If you’d like to see what an atPlatform application looks like, feel free to visit our ‘sample apps’ page! Here, you will find a list of demonstrative applications showing off the many verbs/methods that exist on the atPlatform. The most basic of this list is ‘at_hello_world’ and the most advanced are ‘at_cookbook’ and ‘@mosphere’

How can you contribute?

If you think there should be a change made, or think there could be anything done better, feel free to raise a pull request to the trunk branch.

Take a look at CONTRIBUTING.md for further instructions.

How does stuff get from here to the production site?

When changes are merged to trunk they get published to the staging site devstaging.atsign.wtf by running the HugoBuild GitHub Action, which publishes to the gh-pages branch in this repo.

When a release is tagged with a semanic version number (e.g. 1.0.8) the DeployProd Action runs, which publishes to the gh-pages branch in the atsign.dev-prod repo.

Automated scraping from pub.dev

Some of the content here is taken from pub.dev, which is the authorative source for API docs. The UpdateLibraries Action is set to run at 1415 daily to check for any updates to API docs for our packages.

atsign.dev's Issues

Landing pages design, content and messaging

Hakeem Lead - Next Steps:

• Get review & inputs on home page content
• Import Content to new Docsy template
• Review above Docsy template with team
• #43 (comment)
• #43 (comment)
• [ ] Tied to issue

config.toml remove doks theme residue

Describe the bug
config.toml presently has this at the bottom, which is likely to cause trouble at some stage:

# Doks theme experiment
baseurl = "/"
canonifyURLs = false
disableAliases = true
disableHugoGeneratorInject = true
enableEmoji = true
enableGitInfo = false
enableRobotsTXT = true
languageCode = "en-US"
paginate = 7
rssLimit = 10

Port content from atsign.dev to atsign.dev 2.0

• Getting started
• dess
• Dart Docs
• Documentation
• Sample Apps
• tech Blog
• Community
• Dev program
• New stuff

Easy (for everyone) Ability to edit and preview edits before commit to website.

Add search to site

• keyword search for Google
• @nickelskevin - we need to add Hakeem to the Foundation site
• Add google to index site (next sprint?) @athandle
• @nickelskevin please add Denise (Denise to let you know ID)

Hugo template for the new site

• @nickelskevin please add @rocky to The @ Foundation GitHub site
• @nickelskevin can you please add @Intiserahmed to the Foundation site as well?
• Start with research @rtilney @aannttoo
• Template look and feel draft @aannttoo
• Colors @rtilney

Whitepapers

Utilize current content to redraft

Up to date samples examples for everything

• tied to releases in github

Survey Feedback - Content and UI presentation IMPROVEMENTS

Content Improvements:

• Need time on Information Architecture/Wireframe

• Videos rather than reading content

• More depth example & their clear explanation

• Clear beginner friendly pathway to build @platform app

• Purpose of packages missing

• Backend packages mentioned as api documentation page which is confusing

• Verbs examples should present & explain with ‘CRUD’ operation style

UI Improvements:

• Hard to find good examples
• Hard to quickly find stuff
• Should contain video with short step statements
• Confused understanding in the tech stack
• Have to dig deep in the source code to gain understanding
• This is a good start but need to improve content, search and messaging

Feedback Dislike about the site:

• Lots of punctuation/white space errors
• Google Docs as documentation sources
• Old fashioned design
• Complex Content
• Not beginner friendly
• The getting started puts me off - looks too complex for a start

Other Inputs:

• Should add developer events, opportunities, updates, basically have more dynamic content and programming
• Adopt language self-sovereign data as part of the at protocol
• Upgrade the docs on pub.dev to match atsign.dev
• Blogs need to be more purposeful
• An example app that contains the usage of all the @platform verb meaningfully.

Open Source Policies & Processes

Denise Lead

• Resolve review comments @cpswan
• Write section based on Flutter model @atsigndenise
• Review/edit section
• Determine Schedule for Completion @atsigndenise

Services

The persistence link on the services page is linking to Pub Dev at_contact page. I think is should be pointing to the persistence page instead?

Update Nomenclature on Pub.dev and other pages

Tyler Lead:

Dependency on consolidating nomanclature docs

• PR12.5 decide on which url's to migrate to new site - Refer to #9
• Update content on URL's (may fall to next sprint unless people can update real time as they are going through pages)

Integrate Homepage Messaging with assets and copy into website.

Consumer side @atsigndenise
Developer side @nickelskevin and @aannttoo

Esther's Messaging Doc

• Review and propose changes on homepage messaging (Team)
• Decide on final messaging (Team)
• @rtilney finish creating assets based on final messaging

Decide on name and branding of site

Both
AtSign.Dev
Developer.AtSign.com

New Branding
At Platform

AtSign.Dev Messaging - Homepage

Hakeem Lead - This is only regarding homepage content

• Everyone contribute to the Dev messaging jamboard output (all)
• Create single narrative based on above @eskao654
  High level view of the @ platform
  The features/differentiators/benefits of the @ platform

Copy/Content Edits across the site

Workflow for review

• Review current content on the staging website Keep SEO terms in mind
• Raise PR requests for the suggested changes and edits
• Approve and push directly to website

Work on missing documentation for verbs, samples and examples

Anthony Lead

• Review dev's content

Work on new written content for GAPS identified

• @nickelskevin is going to start reviewing and updating where we have gaps in the verb cookbook
• @TylerTrott & @aannttoo will appraise the Dev teams on missing content via Github issues on the Engg. standups
• Eng stand ups to be used to discuss and prioritize work for the Eng teams

AtSign.dev 2.1 FUTURE

• Publisher Model (requires content)
• Design - Developer experience
• Technology
• Localization
• Integrations
• Social
• Youtube

Review and Edit of @platform Training Handbook.

Jagan, Murali and Sameera are the requested reviewers and their names are mentioned in specific sections of the handbook.

Document how to add content to the site

• document on the site how to add to the site @TylerTrott
• Documentation should be on the site itself! @TylerTrott @aannttoo @cconstab

Survey Feedback - Documentation and instruction IMPROVEMENTS

• Don't like to go google doc to find code snippets
• Lack of flutter code snippets
• Crossover Contents (find out more)
• Need whole doc structure redone (moving away from Google docs should cover issue)
• Confused about which content is current (add dates, keep content current, reflect updates - policy (1st) and process card?)
• If I know what I want, I should be able to search - I have to do so many clicks to navigate (UI)
• @protocol verbs (samples and examples missing)

New sitemap

Sitemap with structure of the different pages needed for the website. We can take the existing ones from the current site and add gaps that exist today

please add @denise to this task. Keywords and sitemap are tied and I want to make sure we are optimizing. I can take a lead role on this if you would like

Integrate Rocky's design into Docsy WTF site

Intiser to lead - Anthony and Tyler to support

Context: Take new assets, CSS files and designs and integrate with Docsy pages.

1. Homepage

• Background
• Github Button add
• Customize button
• Vertical Cards section
• Horizontal Cards section
• Divider
• Video Embed
• Notification and announcement section

2. DocPage

• Add search to doc page only
• Customize search outlook
• Change color to company theme color
• Collapse Functionality

3. ShowcasePage

• Add short background
• Showcase cards
• Learn more button

4. Navigation bar

• Add github and discord button
• change the color to white when the logo is ready.
• Status underline bar

5. Footer

• Add main menu

Customized New look and feel options for landing page based off of the Hugo themes

Sitemap needs to be consolidated (too many nav items)

Describe the bug
The Sitemap needs to be consolidated or reorganized into subpages because it creates too many navigation items

To Reproduce
Steps to reproduce the behavior:

1. First go to https://devstaging.atsign.wtf
2. Observe the top level nav
3. Notice too man items and overcrowded

Expected behavior
Should be clear and concise nav set.

Screenshots

Smartphone (please complete the following information):

• Device: MacBook Pro (15-inch, 2018)
• OS: MacOS 11.3.1 (20E241)
• Browser: Chrome
• Version 90.0.4430.212 (Official Build) (x86_64)

Were you using an @Application when the bug was found?

• No

Additional context
Add any other context about the problem here.

Complete Community Page with new design and content

• Integrate new design and content into the site @TylerTrott
• @rtilney to provide new design for the page

AtDev program site content

Document includes commission program language as well.

• Priority 1 update content 2 pages (currently being worked on by @jenmonroe)
• Exec team sign off on language once team completes
• Build content on staging @rtilney site so @athandle can work on contract piece once Rocky completes
• @athandle completes contract page

On Site search

"Edit this page" on Documentation gets a 404 error

Describe the bug
The "Edit this page" on Documentation gets a 404 error. This is caused by a configuration for the "docs" template to point to "master", needs to be changed to "trunk"

To Reproduce
Steps to reproduce the behavior:

1. First I navigate to and page that uses the "docs"template (e.g. Documentation).
2. Then I click on "Edit this page" on the right side of the page/
3. And then we get a 404 error because it is looking for the "master" branch and we use "trunk"

Expected behavior
The correct pages is found and the developer should be prompted to fork and submit changes...

Screenshots

Smartphone (please complete the following information):

• Device: MacBook Pro (15-inch, 2018)
• OS: MacOS 11.3.1 (20E241)
• Browser: Chrome
• Version 90.0.4430.212 (Official Build) (x86_64)

Were you using an @Application when the bug was found?

• No

Additional context
Add any other context about the problem here.

SEO Keywords inclusion across the site

Barbara Lead

• From the master list of SEO key words identified pick the ones that need to go into the new website
• Include the keywords in the pages as appropriate

AtSign.Dev - Certification Program Offering

Jen Lead

• Placeholder content for launch
• Spell out on the Dev site (Rocky?)
• Workflow certification completed (steps for someone to get certified)

Hugo / docsy theme issue

Describe the bug
The HugoBuild GitHub action fails when it runs content that uses the Docsy theme.
Some useful info can be found here

To Reproduce
Steps to reproduce the behavior:

1. First I checked in some content to a new "poc" branch
2. Then I saw that the HugoBuild started, but failed
3. And then after investigating, discovered that there is an issue with the version of Hugo

Expected behavior
Checking into a "poc" branch would not be deployed to staging.
Hugo should be configured to work with the Docsy theme.

Screenshots

Smartphone (please complete the following information):
Not a device related issue.

Were you using an @Application when the bug was found?
Not an app related issue.

Additional context

Organize docs section with copy, code samples and examples

Lead Anthony

Migration of content, dependent on Pub.dev gaps. Tied to Issue

• Complete framework and documentation for all sections under Functional Arch menu under Docs
• On the Engg. stand ups point out to Dev teams about new issues that have been raised regarding missing documentation, examples and code

Create Full List of FAQs and Answers

Tinashe Lead
We have a document of FAQs that we will continue to add to
Feedback items for reference

• Flutter page ready to go, need to figure out a way to integrate it to the Dev site ( @TylerTrott to work with @cpswan ) #241
• Identify core FAQ's (between 10-15 perhaps?)
• Identify most important questions to answer
• Working session to fill in responses to core questions
• Add more questions based on tickets

**Note that we will continue to add questions slowly over time. This is just to develop an initial list.

Explore Dark mode option on at least the main page

May be an Intern project for the summer

Landing page design for each of main category pages in the top menu

Rocky Lead

XD Prototype: https://xd.adobe.com/view/f8181f50-f288-4e59-99c5-b786dbfc5d66-ad4b/

Add new Glossary section to Docs

Anthony Lead

• Decided not to use a glossary section on the Docs - will cover all the keywords in the existing sections. Glossary will be heard to manage in the long run.

Libraries - Repo Updates

@nickelskevin will review and update description on the libraries repo on Github, so they are consistent and current.

Affects the following pages on AtSign.Dev
http://devstaging.atsign.wtf/docs/functional_architecture/libraries/ - pulls directly from the libraries repos.

Docs Page - Left hand menu items and flow

Anthony lead

Survey Feedback to Interpret across FAQ's

Questions for FAQ

• What is the @dev Program is not clear
• Confused about where to start & what’s the intermediate call to action
• Need to add own personal touch
• Exciting and confused - the benefits are great but I don't know who this is catered to - I also don't know how popular you are

What is liked about the site and can expand on in FAQ?

• Straight point of @protocol benefits
• Can easily access of social media platforms
• Organised resources
• Clean navigation
• Neatly organized

Review and contribute to policy and process outline

• This pr12 dev sprint we would like dev and app dev teams to review the outline for contributing to open source, and start the process of contribution

• Use Flutter as a template for open source dev site contributions (@kevin -- please add the link)

SEO

• Pick terms to optimize

Identify sections under Docs that need new videos and content

Tyler T to lead - support from Intiser and Anthony

Tied to issue
Need developer team support for enhanced content on technology documentation (Pub.dev) @VJag @murali-shris

Dev/Ops stuff

• create DNS for the site in wtf @cpswan
• automate builds @cpswan

Libraries

Hi @cpswan I think this page is pulling automatically from the Pub.Dev pages. I found some inconsistencies in the usage of @sign (atsign) and @protocol (atprotocol).

For example look at at_contacts_flutter and at_chat_flutter vs at_backupkey_flutter.

I didn't want to update anything in case its auto updating. Also want to confirm is this intentional or should it be updated?

I opened another ticket on description inconsistencies as well issue #118 and #136

Create assets corresponding to new messaging for Homepage

Rocky Lead

@aannttoo thinks we may need up to 6 new graphics for the homepage.

AtSign.Dev - Dev Program Design

Jen Lead
Once done, Ashish will complete this card

• Content placed on the new Hugo site

Identify new videos to be recorded

• Get Started playlist on YouTube
• @verb/methods showcase

Policy and Process

Short term scope - long term large task

• define policy and process for atsign.dev @aannttoo @cpswan

Prep Github for Production Push

• Create new setup on Github for the incoming production instance of the 2.0 site
• Testing as needed
• Launch when ready