eclipse-thingweb / website Goto Github PK

reference on Eclipse, see https://bugs.eclipse.org/bugs/show_bug.cgi?id=534527

check code, see example

• https://www.thingweb.io/smart-coffee-machine.html
• https://www.thingweb.io/hands-on-intro-raspberry.html
• more?

@sebastiankb feels like it is difficult to find/see the GitHub Link (at the moment present in footer and prose).
How can we improve the situation? Have its "own" navigation item?

@egekorkan others opinions?

We plan to rework the structure & content of the Website anyway..

Headers width is "larger" then the footer ...

Overarching issue to keep track of updates

• create playground like "NPM runkit" or "TypeScript playground"
• More samples?
• Redesign website: remove/reduce BIG header image on website, see #26
• ...

At the moment by default thingweb.io gets delivered purely without a secure connection
see http://www.thingweb.io/
even though the secure connection is in place
see https://www.thingweb.io/

Currently, the news section is sort of mirroring the https://www.w3.org/WoT/activities/events/ . I think we can make it more focused on Thingweb like releases etc. and point to W3C WoT mainpage for WoT news in general. Any thoughts?

see https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/1129

I did a quick check and it seems to work fine.

@sebastiankb @egekorkan @wiresio @relu91 please let me know if you encounter any issues

Similar to the way w3c repositories generate a static page for every PR, it would be nice to add a bot that does this for this repository. This might however need the involvement of someone from the Eclipse Foundation.

Our news page is regularly out-of-date.

Having said that, I don't think we should any longer maintain our own news page. We could simply point to other resources like Mastodon/X, Stackoverflow and WoT Wiki pages instead.

OR

remove the page all together.

Any thoughts/ideas/proposals?

see http://www.thingweb.io/smart-coffee-machine.html

I suggest we change

title: 'Smart Coffee Machine'
to
title: 'Smart-Coffee-Machine'

(changing spaces with -)

Doing so helps to get rid of all these %20 characters for space in tutorial that just confuses people what it is for.
What do you think @fatadel?
Can we update the tutorial on the website and the according example in node-wot?

I have Hugo v0.115.4+extended on linux and the build fails. The action to deploy uses 0.79 at https://github.com/eclipse-thingweb/website/blob/master/.github/workflows/gh-pages.yml so maybe that is why that works. Specifying version on Netlify seems to be fine and publishes the website

In the coffee machine tutorial, there is the following code:

    thing.setPropertyReadHandler('availableResourceLevel', (options) => {

        // Check if uriVariables are provided
        if (options && typeof options === 'object' && 'uriVariables' in options) {
            const uriVariables: any = options['uriVariables'];
            if ('id' in uriVariables) {
                return thing.readProperty('allAvailableResources').then((resources) => {
                    const id = uriVariables['id'];
                    return new Promise((resolve, reject) => {
                        resolve(resources[id]);
                    });
                });
            }
        }
        return new Promise((resolve, reject) => {
            resolve('Please specify id variable as uriVariables.');
        });
    });

The first part is completely fine but the last lines on returning a Promise will actually make the Client think that everything is OK since in HTTP it would map to 200 status code. The correct way would be to return an HTTP 400 Bad Request but this is not possible at the moment (See this issue on node-wot: eclipse-thingweb/node-wot#140). For now, this should at least be a reject instead of a resolve.

Could you correct this @fatadel ?

It seems that the get involved page is the second most viewed page on our website. It is already good but we could add for example links to our social accounts (Discord and Telegram) to get some traffic also there.

We can have buttons like at https://buttons.github.io/ (especially star) so that people are more inclined to give a star to Thingweb components.

So the title is pretty self-explaining. If approved I can add it myself.

improve syntax highlighting...

e.g., https://gohugo.io/content-management/syntax-highlighting/

Once the consent banner is hidden it might be difficult for users to find the "Manage Cookies" link in the footer. Anyhow, I don't have a good alternative other than creating a dedicated cookie button in the bottom right corner or so... not sure if this might work better.

An example what I mean can be seen on
https://www.cookieyes.com/documentation/change-cookie-consent-using-cookieyes/

Originally posted by @danielpeintner in #74 (comment)

w.r.t. the templates, may I ask you @egekorkan or @FadySalama, see http://www.thingweb.io/hands-on-exposed-thing-guide.html or https://github.com/eclipse/thingweb.website/pull/30/files#diff-3e5f0c02d97d77d683bc5797291a47c01e3678d34a8404f7f25f0b713a74788a

Originally posted by @danielpeintner in #30 (comment)

@fatadel Your coffee machine tutorial has some misleading parts.

1. In the event affordances, you say:

// Set up a handler for outOfResource event     

thing.subscribeEvent('outOfResource', (data) => {          
// Notify an "admin" when the event is emitted         
// (the notify function here simply logs a message to the console)
notify('[email protected]', `outOfResource event: ${data}`);     
});

This is not really a handler for the events since events do not have a handler like properties and actions do, you just emit them. By the way you emit them in the part of Action Affordances anyways, so you can call the notify function in there and not create another listener for this. I am guessing that you did this to be symmetrical to other affordances but I think that we should not encourage this. The text gives the impression that there is some real event handling happening.

2. You have a Property Affordance called allAvailableResources. However, node-wot automatically generates handlers for meta interactions like readallproperties. Were you aware of this or is this property there for another reason?

3.Also, there is no name displayed on the page/tab. Similarly, the hands-on page displays thingweb-thingweb. Could you take a look at it @danielpeintner ?

We also have a page at http://plugfest.thingweb.io/examples/smart-coffee-machine.html . We should decide where it should be versioned.

Similar to the discussion in w3c/wot-marketing#473 we should think about not opening new tabs/pages when clicking on links...

Is everyone fine if I provide a PR?

If one follows the Coffee Machine tutorial and compiles their own JavaScript files, the information that is in the README of the examples. So the tutorial seems to (and sort of does) produce non-executable code.

I think the information in the above-linked readme should be also present in the tutorial. @fatadel can you have a look?

Search engine optimization (SEO) is needed to improve search engine ranking.

• more/better text (#28)
• add metadata (see #29)
• JSON-LD from schema.org

see https://gitlab.eclipse.org/eclipsefdn/emo-team/emo/-/issues/192#note_572859

The project website should be modified to include all [necessary elements] in the footer(https://www.eclipse.org/projects/handbook/#trademarks-website-footer)

I am pretty sure we once had a more or less page showing that a page does no longer exist.

Now, this is no longer the case and we have something like this, try for example https://www.thingweb.io/foo/